From 3563feda0d9e7513db2357d0aaacd5c3cd20d62b Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 16 Jul 2025 15:34:21 -0500 Subject: [PATCH 1/2] Move `Applicable:` tags and fixcontent formatting --- .../Add-SPOContainerTypeBilling.md | 4 - .../Add-SPOContentSecurityPolicy.md | 1 - .../Add-SPOGeoAdministrator.md | 3 - .../Add-SPOHubSiteAssociation.md | 2 - .../Add-SPOOrgAssetsLibrary.md | 2 - .../Add-SPOSiteCollectionAppCatalog.md | 3 - .../Add-SPOTenantCdnOrigin.md | 3 - .../Add-SPOUser.md | 3 - ...POTenantServicePrincipalPermissionGrant.md | 3 - .../Connect-SPOService.md | 5 - .../ConvertTo-SPOMigrationEncryptedPackage.md | 7 - .../ConvertTo-SPOMigrationTargetedPackage.md | 15 -- .../Copy-SPOPersonalSitePage.md | 4 - .../Enable-SPOCommSite.md | 1 - .../Export-SPOQueryLogs.md | 4 - .../Export-SPOUserInfo.md | 3 - .../Export-SPOUserProfile.md | 2 - .../Get-FileSensitivityLabelInfo.md | 1 - .../Get-SPOAppErrors.md | 3 - .../Get-SPOAppInfo.md | 2 - .../Get-SPOApplication.md | 7 +- .../Get-SPOBuiltInSiteTemplateSettings.md | 2 - .../Get-SPOContainer.md | 25 -- .../Get-SPOContainerType.md | 1 - .../Get-SPOContainerTypeConfiguration.md | 1 - .../Get-SPOCopilotAgentInsightsReport.md | 3 - .../Get-SPOCrossGeoMovedUsers.md | 1 - .../Get-SPOCrossGeoUsers.md | 1 - .../Get-SPOCrossTenantCompatibilityStatus.md | 1 - .../Get-SPODeletedContainer.md | 1 - .../Get-SPODeletedSite.md | 4 - .../Get-SPOEnterpriseAppInsightsReport.md | 2 - .../Get-SPOExternalUser.md | 6 - .../Get-SPOGeoStorageQuota.md | 1 - .../Get-SPOHubSite.md | 1 - .../Get-SPOMalwareFile.md | 2 - .../Get-SPOMalwareFileContent.md | 1 - .../Get-SPOMigrationJobProgress.md | 8 - .../Get-SPOMigrationJobStatus.md | 4 - .../Get-SPOPersonalSitePageCopyProgress.md | 3 - .../Get-SPOSite.md | 13 -- .../Get-SPOSiteContentMoveState.md | 1 - .../Get-SPOSiteGroup.md | 3 - .../Get-SPOSitePages.md | 2 - ...t-SPOStructuralNavigationCacheSiteState.md | 1 - .../Get-SPOTenantCdnEnabled.md | 1 - .../Get-SPOTenantCdnOrigins.md | 1 - .../Get-SPOTenantCdnPolicies.md | 1 - .../Get-SPOTenantLogEntry.md | 6 - .../Get-SPOUser.md | 4 - .../Get-SPOUserAndContentMoveState.md | 6 - .../Get-SPOUserOneDriveLocation.md | 1 - .../Get-SPOWebTemplate.md | 4 - .../Grant-SPOHubSiteRights.md | 3 - .../Invoke-SPOMigrationEncryptUploadSubmit.md | 6 - .../Invoke-SPOSiteSwap.md | 6 - .../New-SPOAppBillingPolicy.md | 5 - .../New-SPOContainerType.md | 11 - .../New-SPOMigrationPackage.md | 10 - .../New-SPOPublicCdnOrigin.md | 3 - .../New-SPOSdnProvider.md | 4 - .../New-SPOSite.md | 10 - .../New-SPOSiteGroup.md | 3 - .../Register-SPOHubSite.md | 2 - .../Remove-SPOAppBillingPolicy.md | 1 - .../Remove-SPOContainer.md | 1 - .../Remove-SPOContainerType.md | 1 - .../Remove-SPOContentSecurityPolicy.md | 1 - .../Remove-SPODeletedContainer.md | 6 - .../Remove-SPODeletedSite.md | 6 +- .../Remove-SPOExternalUser.md | 2 +- .../Remove-SPOGeoAdministrator.md | 1 - .../Remove-SPOHubSiteAssociation.md | 1 - .../Remove-SPOMigrationJob.md | 4 - .../Remove-SPOOrgNewsSite.md | 1 - .../Remove-SPOPublicCdnOrigin.md | 3 - .../Remove-SPOSdnProvider.md | 2 - .../Remove-SPOSite.md | 4 - .../Remove-SPOSiteGroup.md | 4 +- .../Remove-SPOTenantCdnOrigin.md | 4 - .../Remove-SPOTenantSyncClientRestriction.md | 2 +- .../Remove-SPOUser.md | 5 +- .../Remove-SPOUserInfo.md | 3 - .../Remove-SPOUserProfile.md | 1 - .../Repair-SPOSite.md | 5 - .../Request-SPOPersonalSite.md | 2 - .../Request-SPOUpgradeEvaluationSite.md | 5 - .../Restore-SPODeletedContainer.md | 6 - .../Restore-SPODeletedSite.md | 2 - .../Revoke-SPOHubSiteRights.md | 2 - .../Revoke-SPOUserSession.md | 3 - .../Set-SPOApplication.md | 1 - .../Set-SPOApplicationPermission.md | 6 - .../Set-SPOBuiltInSiteTemplateSettings.md | 6 - .../Set-SPOContainer.md | 2 - .../Set-SPOContainerType.md | 3 - .../Set-SPOContainerTypeConfiguration.md | 1 - .../Set-SPOCopilotPromoOptInStatus.md | 1 - .../Set-SPOCrossTenantRelationship.md | 3 - .../Set-SPODisableSpacesActivation.md | 1 - .../Set-SPOGeoStorageQuota.md | 2 - .../Set-SPOHubSite.md | 6 - .../Set-SPOMigrationPackageAzureSource.md | 1 - .../Set-SPOOrgNewsSite.md | 1 - .../Set-SPORestrictedSiteCreation.md | 1 - ...SPOServicePrioritizationAppRegistration.md | 1 - .../Set-SPOSite.md | 1 - .../Set-SPOSiteArchiveState.md | 1 - .../Set-SPOSiteOffice365Group.md | 6 - ...t-SPOStructuralNavigationCacheSiteState.md | 1 - .../Set-SPOTenant.md | 1 - .../Set-SPOTenantSyncClientRestriction.md | 5 - .../Start-SPOCopilotAgentInsightsReport.md | 2 - .../Start-SPOEnterpriseAppInsightsReport.md | 2 - ...art-SPORestrictedAccessForSitesInsights.md | 3 - .../Start-SPOSiteContentMove.md | 1 - ...SiteOpticalCharacterRecognitionBackfill.md | 1 - .../Start-SPOSiteRename.md | 9 - .../Start-SPOTenantRename.md | 3 - .../Start-SPOUserAndContentMove.md | 6 - .../Stop-SPOTenantRename.md | 2 - .../Stop-SPOUserAndContentMove.md | 1 - .../Submit-SPOMigrationJob.md | 9 - .../Test-SPOSite.md | 3 - ...Unlock-SPOSensitivityLabelEncryptedFile.md | 2 - .../Unregister-SPOHubSite.md | 3 - .../Update-UserType.md | 1 - .../Add-DatabaseToAvailabilityGroup.md | 40 ++-- .../Add-FASTSearchResource.md | 12 +- .../Add-SPAppDeniedEndpoint.md | 23 +- .../Add-SPClaimTypeMapping.md | 27 ++- .../Add-SPDiagnosticsPerformanceCounter.md | 90 ++++--- .../Add-SPDistributedCacheServiceInstance.md | 24 +- .../Add-SPEduClassMember.md | 33 ++- .../Add-SPEduUser.md | 45 ++-- .../Add-SPInfoPathUserAgent.md | 22 +- .../Add-SPPluggableSecurityTrimmer.md | 40 ++-- .../Add-SPProfileLeader.md | 34 ++- .../Add-SPProfileSyncConnection.md | 108 ++++++--- .../Add-SPRoutingMachineInfo.md | 45 ++-- .../Add-SPRoutingMachinePool.md | 27 ++- .../Add-SPRoutingRule.md | 45 ++-- .../Add-SPScaleOutDatabase.md | 53 +++-- .../Add-SPSecureStoreSystemAccount.md | 22 +- .../Add-SPServerScaleOutDatabase.md | 48 ++-- ...dd-SPServiceApplicationProxyGroupMember.md | 27 ++- .../Add-SPShellAdmin.md | 35 +-- ...Add-SPSiteSubscriptionFeaturePackMember.md | 29 ++- .../Add-SPSiteSubscriptionProfileConfig.md | 65 +++--- .../Add-SPSolution.md | 28 ++- .../Add-SPThrottlingRule.md | 39 ++-- .../Add-SPUserLicenseMapping.md | 23 +- .../Add-SPUserSolution.md | 29 ++- .../Backup-SPConfigurationDatabase.md | 47 ++-- ...EnterpriseSearchServiceApplicationIndex.md | 79 ++++--- .../Backup-SPFarm.md | 71 ++++-- .../Backup-SPSite.md | 60 +++-- .../Clear-FASTSearchContentCollection.md | 24 +- .../Clear-SPAppDeniedEndpointList.md | 19 +- ...usinessDataCatalogEntityNotificationWeb.md | 23 +- .../Clear-SPContentDatabaseSyncData.md | 20 +- .../Clear-SPDistributedCacheItem.md | 23 +- .../Clear-SPLogLevel.md | 27 ++- ...Clear-SPMetadataWebServicePartitionData.md | 38 +-- ...ePointServiceApplicationTrustedLocation.md | 28 ++- ...r-SPScaleOutDatabaseDeletedDataSubRange.md | 35 ++- .../Clear-SPScaleOutDatabaseLog.md | 28 ++- .../Clear-SPScaleOutDatabaseTenantData.md | 29 ++- .../Clear-SPSecureStoreCredentialMapping.md | 40 ++-- .../Clear-SPSecureStoreDefaultProvider.md | 8 +- ...rverScaleOutDatabaseDeletedDataSubRange.md | 31 +-- .../Clear-SPServerScaleOutDatabaseLog.md | 25 +- ...lear-SPServerScaleOutDatabaseTenantData.md | 24 +- ...teSubscriptionBusinessDataCatalogConfig.md | 23 +- .../Connect-SPConfigurationDatabase.md | 51 ++-- .../Convert-SPWebApplication.md | 89 ++++--- ...opy-SPAccessServicesDatabaseCredentials.md | 36 ++- .../Copy-SPActivitiesToWorkflowService.md | 46 ++-- ...Copy-SPBusinessDataCatalogAclToChildren.md | 23 +- .../Copy-SPContentTypes.md | 56 +++-- .../Copy-SPSideBySideFiles.md | 14 +- .../Copy-SPSite.md | 39 ++-- .../Copy-SPTaxonomyGroups.md | 49 ++-- .../Disable-ProjectServerLicense.md | 8 +- .../Disable-SPAppAutoProvision.md | 17 +- .../Disable-SPBusinessDataCatalogEntity.md | 23 +- .../Disable-SPFeature.md | 37 +-- .../Disable-SPHealthAnalysisRule.md | 23 +- .../Disable-SPInfoPathFormTemplate.md | 26 ++- ...tiveDirectoryEnterpriseResourcePoolSync.md | 14 +- .../Disable-SPProjectEmailNotification.md | 14 +- ...able-SPProjectEnterpriseProjectTaskSync.md | 14 +- .../Disable-SPProjectQueueStatsMonitoring.md | 8 +- .../Disable-SPSessionStateService.md | 16 +- .../Disable-SPSingleSignOn.md | 22 +- .../Disable-SPTimerJob.md | 23 +- .../Disable-SPUserLicensing.md | 17 +- .../Disable-SPUserSolutionAllowList.md | 16 +- .../Disable-SPWebApplicationHttpThrottling.md | 23 +- .../Disable-SPWebTemplateForSiteMaster.md | 20 +- .../Disconnect-SPConfigurationDatabase.md | 17 +- .../Dismount-SPContentDatabase.md | 25 +- .../Dismount-SPSiteMapDatabase.md | 22 +- .../Dismount-SPStateServiceDatabase.md | 22 +- .../Enable-ProjectServerLicense.md | 14 +- .../Enable-SPAppAutoProvision.md | 16 +- .../Enable-SPBusinessDataCatalogEntity.md | 23 +- .../Enable-SPFeature.md | 50 ++-- .../Enable-SPHealthAnalysisRule.md | 15 +- .../Enable-SPInfoPathFormTemplate.md | 26 ++- ...tiveDirectoryEnterpriseResourcePoolSync.md | 18 +- .../Enable-SPProjectEmailNotification.md | 14 +- ...able-SPProjectEnterpriseProjectTaskSync.md | 14 +- .../Enable-SPProjectQueueStatsMonitoring.md | 8 +- .../Enable-SPSessionStateService.md | 48 ++-- .../Enable-SPTimerJob.md | 23 +- .../Enable-SPUserLicensing.md | 17 +- .../Enable-SPUserSolutionAllowList.md | 16 +- .../Enable-SPWebApplicationHttpThrottling.md | 23 +- .../Enable-SPWebTemplateForSiteMaster.md | 20 +- .../Export-SPAccessServicesDatabase.md | 20 +- .../Export-SPAppPackage.md | 20 +- .../Export-SPBusinessDataCatalogModel.md | 65 ++++-- .../Export-SPEnterpriseSearchTopology.md | 28 ++- .../Export-SPInfoPathAdministrationFiles.md | 28 ++- ...xport-SPMetadataWebServicePartitionData.md | 32 ++- .../Export-SPPerformancePointContent.md | 20 +- .../Export-SPScaleOutDatabaseTenantData.md | 41 ++-- ...port-SPServerScaleOutDatabaseTenantData.md | 41 ++-- ...teSubscriptionBusinessDataCatalogConfig.md | 65 ++++-- .../Export-SPSiteSubscriptionSettings.md | 36 +-- .../Export-SPTagsAndNotesData.md | 20 +- .../Export-SPWeb.md | 100 +++++--- .../Get-AvailabilityGroupStatus.md | 18 +- .../Get-FASTSearchContentCollection.md | 10 +- ...et-FASTSearchDocumentProcessingPipeline.md | 10 +- .../Get-FASTSearchMetadataCategory.md | 12 +- .../Get-FASTSearchMetadataCrawledProperty.md | 38 +-- ...ASTSearchMetadataCrawledPropertyMapping.md | 18 +- .../Get-FASTSearchMetadataFullTextIndex.md | 6 +- ...-FASTSearchMetadataFullTextIndexMapping.md | 16 +- .../Get-FASTSearchMetadataManagedProperty.md | 8 +- .../Get-FASTSearchMetadataRankProfile.md | 8 +- .../Get-FASTSearchResource.md | 12 +- .../Get-FASTSearchSearchSettingGroup.md | 10 +- .../Get-FASTSearchSecurityAliaser.md | 10 +- .../Get-FASTSearchSecurityCCTKServer.md | 2 +- .../Get-FASTSearchSecurityClaimsUserStore.md | 8 +- ...ASTSearchSecurityCompleteGroupExpansion.md | 32 ++- .../Get-FASTSearchSecurityDecodedSid.md | 8 +- .../Get-FASTSearchSecurityDefaultUserStore.md | 10 +- .../Get-FASTSearchSecurityEncodedSid.md | 16 +- .../Get-FASTSearchSecurityGeneralSettings.md | 8 +- .../Get-FASTSearchSecurityLogLevel.md | 8 +- ...t-FASTSearchSecurityLotusNotesUserStore.md | 8 +- .../Get-FASTSearchSecurityPublicFilter.md | 10 +- .../Get-FASTSearchSecurityRegexAliaser.md | 8 +- .../Get-FASTSearchSecurityUserFilter.md | 20 +- .../Get-FASTSearchSecurityUserStore.md | 10 +- ...STSearchSecurityUserStoreGroupExpansion.md | 22 +- .../Get-FASTSearchSecurityWorkerNode.md | 22 +- .../Get-FASTSearchSecurityXMLAliaser.md | 10 +- .../Get-FASTSearchSpelltuningStatus.md | 2 +- .../Get-ProjectServerLicense.md | 8 +- .../Get-SPAccessServiceApplication.md | 18 +- .../Get-SPAccessServicesApplication.md | 18 +- .../Get-SPAccessServicesDatabase.md | 28 ++- .../Get-SPAccessServicesDatabaseServer.md | 43 ++-- ...Get-SPAccessServicesDatabaseServerGroup.md | 20 +- ...ccessServicesDatabaseServerGroupMapping.md | 22 +- .../Get-SPAlternateURL.md | 35 +-- .../Get-SPAppAcquisitionConfiguration.md | 20 +- .../Get-SPAppAutoProvisionConnection.md | 23 +- .../Get-SPAppDeniedEndpointList.md | 10 +- .../Get-SPAppDisablingConfiguration.md | 9 +- .../Get-SPAppDomain.md | 9 +- .../Get-SPAppHostingQuotaConfiguration.md | 21 +- .../Get-SPAppInstance.md | 40 ++-- .../Get-SPAppPrincipal.md | 21 +- .../Get-SPAppScaleProfile.md | 7 +- .../Get-SPAppSiteSubscriptionName.md | 17 +- .../Get-SPAppStateSyncLastRunTime.md | 9 +- .../Get-SPAppStateUpdateInterval.md | 8 +- .../Get-SPAppStoreConfiguration.md | 7 +- .../Get-SPAppStoreWebServiceConfiguration.md | 8 +- .../Get-SPAuthenticationProvider.md | 29 ++- .../Get-SPAuthenticationRealm.md | 14 +- .../Get-SPBackupHistory.md | 31 ++- .../Get-SPBingMapsBlock.md | 9 +- .../Get-SPBingMapsKey.md | 9 +- ...serCustomerExperienceImprovementProgram.md | 29 ++- ...usinessDataCatalogEntityNotificationWeb.md | 15 +- ...Get-SPBusinessDataCatalogMetadataObject.md | 39 ++-- ...Get-SPBusinessDataCatalogThrottleConfig.md | 33 ++- .../Get-SPCertificateAuthority.md | 9 +- .../Get-SPClaimProvider.md | 15 +- .../Get-SPClaimProviderManager.md | 9 +- .../Get-SPClaimTypeEncoding.md | 25 +- ...PConnectedServiceApplicationInformation.md | 14 +- .../Get-SPContentDatabase.md | 62 +++-- .../Get-SPContentDatabaseOrphanedData.md | 15 +- .../Get-SPContentDeploymentJob.md | 20 +- .../Get-SPContentDeploymentPath.md | 14 +- .../Get-SPCustomLayoutsPage.md | 27 ++- .../Get-SPDataConnectionFile.md | 18 +- .../Get-SPDataConnectionFileDependent.md | 14 +- .../Get-SPDatabase.md | 29 ++- .../Get-SPDeletedSite.md | 63 +++-- .../Get-SPDesignerSettings.md | 15 +- .../Get-SPDiagnosticConfig.md | 9 +- .../Get-SPDiagnosticsPerformanceCounter.md | 25 +- .../Get-SPDiagnosticsProvider.md | 17 +- .../Get-SPDistributedCacheClientSetting.md | 15 +- .../Get-SPEduServiceSetting.md | 21 +- ...EnterpriseSearchAdministrationComponent.md | 14 +- .../Get-SPEnterpriseSearchComponent.md | 29 ++- ...iseSearchContentEnrichmentConfiguration.md | 15 +- ...et-SPEnterpriseSearchCrawlContentSource.md | 20 +- ...-SPEnterpriseSearchCrawlCustomConnector.md | 20 +- .../Get-SPEnterpriseSearchCrawlDatabase.md | 20 +- .../Get-SPEnterpriseSearchCrawlExtension.md | 20 +- ...PEnterpriseSearchCrawlLogReadPermission.md | 20 +- .../Get-SPEnterpriseSearchCrawlMapping.md | 18 +- .../Get-SPEnterpriseSearchCrawlRule.md | 24 +- .../Get-SPEnterpriseSearchFileFormat.md | 23 +- .../Get-SPEnterpriseSearchHostController.md | 16 +- ...PEnterpriseSearchLanguageResourcePhrase.md | 48 ++-- ...erpriseSearchLinguisticComponentsStatus.md | 20 +- .../Get-SPEnterpriseSearchLinksDatabase.md | 20 +- .../Get-SPEnterpriseSearchMetadataCategory.md | 32 ++- ...EnterpriseSearchMetadataCrawledProperty.md | 42 ++-- ...EnterpriseSearchMetadataManagedProperty.md | 38 +-- .../Get-SPEnterpriseSearchMetadataMapping.md | 38 +-- .../Get-SPEnterpriseSearchOwner.md | 24 +- .../Get-SPEnterpriseSearchPropertyRule.md | 20 +- ...PEnterpriseSearchPropertyRuleCollection.md | 8 +- ...rpriseSearchQueryAndSiteSettingsService.md | 8 +- ...archQueryAndSiteSettingsServiceInstance.md | 22 +- ...eSearchQueryAndSiteSettingsServiceProxy.md | 8 +- .../Get-SPEnterpriseSearchQueryAuthority.md | 26 ++- .../Get-SPEnterpriseSearchQueryDemoted.md | 24 +- .../Get-SPEnterpriseSearchQueryKeyword.md | 20 +- .../Get-SPEnterpriseSearchQueryScope.md | 24 +- .../Get-SPEnterpriseSearchQueryScopeRule.md | 30 ++- ...EnterpriseSearchQuerySpellingCorrection.md | 19 +- ...terpriseSearchQuerySuggestionCandidates.md | 24 +- .../Get-SPEnterpriseSearchRankingModel.md | 26 ++- .../Get-SPEnterpriseSearchResultItemType.md | 33 ++- .../Get-SPEnterpriseSearchResultSource.md | 29 ++- .../Get-SPEnterpriseSearchSecurityTrimmer.md | 20 +- .../Get-SPEnterpriseSearchService.md | 8 +- ...et-SPEnterpriseSearchServiceApplication.md | 14 +- ...riseSearchServiceApplicationBackupStore.md | 50 ++-- ...EnterpriseSearchServiceApplicationProxy.md | 14 +- .../Get-SPEnterpriseSearchServiceInstance.md | 22 +- .../Get-SPEnterpriseSearchSiteHitRule.md | 20 +- .../Get-SPEnterpriseSearchStatus.md | 81 ++++--- .../Get-SPEnterpriseSearchTopology.md | 30 ++- .../Get-SPEnterpriseSearchVssDataPath.md | 13 +- .../Get-SPExcelBIServer.md | 20 +- .../Get-SPExcelBlockedFileType.md | 21 +- .../Get-SPExcelDataConnectionLibrary.md | 24 +- .../Get-SPExcelDataProvider.md | 16 +- .../Get-SPExcelFileLocation.md | 24 +- .../Get-SPExcelServiceApplication.md | 20 +- .../Get-SPExcelUserDefinedFunction.md | 24 +- .../Get-SPFarm.md | 9 +- .../Get-SPFarmConfig.md | 17 +- .../Get-SPFeature.md | 59 +++-- .../Get-SPHealthAnalysisRule.md | 15 +- .../Get-SPHelpCollection.md | 15 +- .../Get-SPIRMSettings.md | 9 +- .../Get-SPInfoPathFormTemplate.md | 16 +- .../Get-SPInfoPathFormsService.md | 14 +- .../Get-SPInfoPathUserAgent.md | 14 +- .../Get-SPInfoPathWebServiceProxy.md | 14 +- .../Get-SPInsightsConfig.md | 17 +- .../Get-SPInternalAppStateSyncLastRunTime.md | 9 +- .../Get-SPInternalAppStateUpdateInterval.md | 9 +- .../Get-SPLogEvent.md | 61 +++-- .../Get-SPLogLevel.md | 21 +- .../Get-SPManagedAccount.md | 33 ++- .../Get-SPManagedPath.md | 31 ++- .../Get-SPMetadataServiceApplication.md | 14 +- .../Get-SPMetadataServiceApplicationProxy.md | 14 +- .../Get-SPMicrofeedOptions.md | 20 +- .../Get-SPMobileMessagingAccount.md | 19 +- .../Get-SPO365LinkSettings.md | 6 +- .../Get-SPODataConnectionSetting.md | 28 +-- .../Get-SPODataConnectionSettingMetadata.md | 26 +-- .../Get-SPOfficeStoreAppsDefaultActivation.md | 27 +-- .../Get-SPPendingUpgradeActions.md | 27 ++- ...et-SPPerformancePointServiceApplication.md | 22 +- ...ePointServiceApplicationTrustedLocation.md | 28 ++- .../Get-SPPluggableSecurityTrimmer.md | 14 +- .../Get-SPProcessAccount.md | 29 ++- .../Get-SPProduct.md | 21 +- .../Get-SPProfileLeader.md | 20 +- ...Get-SPProfileServiceApplicationSecurity.md | 26 ++- .../Get-SPProjectDatabaseQuota.md | 14 +- .../Get-SPProjectDatabaseUsage.md | 14 +- .../Get-SPProjectEnterpriseProjectTaskSync.md | 14 +- .../Get-SPProjectEventServiceSettings.md | 8 +- ...Get-SPProjectIsEmailNotificationEnabled.md | 14 +- .../Get-SPProjectOdataConfiguration.md | 12 +- .../Get-SPProjectPCSSettings.md | 12 +- .../Get-SPProjectPermissionMode.md | 14 +- .../Get-SPProjectQueueSettings.md | 12 +- .../Get-SPProjectWebInstance.md | 18 +- .../Get-SPRequestManagementSettings.md | 15 +- .../Get-SPRoutingMachineInfo.md | 27 ++- .../Get-SPRoutingMachinePool.md | 21 +- .../Get-SPRoutingRule.md | 21 +- .../Get-SPScaleOutDatabase.md | 23 +- .../Get-SPScaleOutDatabaseDataState.md | 35 ++- .../Get-SPScaleOutDatabaseInconsistency.md | 23 +- .../Get-SPScaleOutDatabaseLogEntry.md | 47 ++-- .../Get-SPSecureStoreApplication.md | 28 ++- .../Get-SPSecureStoreSystemAccount.md | 8 +- .../Get-SPSecurityTokenServiceConfig.md | 9 +- .../Get-SPServer.md | 15 +- .../Get-SPServerScaleOutDatabase.md | 27 +-- .../Get-SPServerScaleOutDatabaseDataState.md | 39 ++-- ...t-SPServerScaleOutDatabaseInconsistency.md | 24 +- .../Get-SPServerScaleOutDatabaseLogEntry.md | 51 ++-- .../Get-SPService.md | 20 +- .../Get-SPServiceApplication.md | 25 +- .../Get-SPServiceApplicationEndpoint.md | 27 ++- .../Get-SPServiceApplicationPool.md | 15 +- .../Get-SPServiceApplicationProxy.md | 15 +- .../Get-SPServiceApplicationProxyGroup.md | 21 +- .../Get-SPServiceApplicationSecurity.md | 21 +- .../Get-SPServiceContext.md | 21 +- .../Get-SPServiceHostConfig.md | 15 +- .../Get-SPServiceInstance.md | 27 ++- .../Get-SPSessionStateService.md | 8 +- .../Get-SPShellAdmin.md | 15 +- .../Get-SPSite.md | 87 ++++--- .../Get-SPSiteAdministration.md | 71 +++--- .../Get-SPSiteMapDatabase.md | 16 +- .../Get-SPSiteMaster.md | 14 +- .../Get-SPSiteSubscription.md | 15 +- .../Get-SPSiteSubscriptionConfig.md | 15 +- .../Get-SPSiteSubscriptionEdiscoveryHub.md | 22 +- ...SPSiteSubscriptionEdiscoverySearchScope.md | 22 +- .../Get-SPSiteSubscriptionFeaturePack.md | 23 +- .../Get-SPSiteSubscriptionIRMConfig.md | 15 +- .../Get-SPSiteSubscriptionMetadataConfig.md | 20 +- .../Get-SPSiteURL.md | 23 +- .../Get-SPSiteUpgradeSessionInfo.md | 53 +++-- .../Get-SPSolution.md | 15 +- .../Get-SPStateServiceApplication.md | 22 +- .../Get-SPStateServiceApplicationProxy.md | 22 +- .../Get-SPStateServiceDatabase.md | 28 ++- .../Get-SPTaxonomySession.md | 14 +- .../Get-SPThrottlingRule.md | 21 +- .../Get-SPTimerJob.md | 28 ++- .../Get-SPTopologyServiceApplication.md | 15 +- .../Get-SPTopologyServiceApplicationProxy.md | 15 +- .../Get-SPTranslationThrottlingSetting.md | 24 +- .../Get-SPTrustedIdentityTokenIssuer.md | 15 +- .../Get-SPTrustedRootAuthority.md | 15 +- .../Get-SPTrustedSecurityTokenIssuer.md | 15 +- .../Get-SPTrustedServiceTokenIssuer.md | 15 +- .../Get-SPUpgradeActions.md | 9 +- .../Get-SPUsageApplication.md | 21 +- .../Get-SPUsageDefinition.md | 15 +- .../Get-SPUsageService.md | 15 +- .../Get-SPUser.md | 38 +-- .../Get-SPUserLicense.md | 9 +- .../Get-SPUserLicenseMapping.md | 19 +- .../Get-SPUserLicensing.md | 9 +- .../Get-SPUserSettingsProvider.md | 15 +- .../Get-SPUserSettingsProviderManager.md | 9 +- .../Get-SPUserSolution.md | 21 +- .../Get-SPUserSolutionAllowList.md | 22 +- .../Get-SPVisioExternalData.md | 16 +- .../Get-SPVisioPerformance.md | 14 +- .../Get-SPVisioSafeDataProvider.md | 28 ++- .../Get-SPVisioServiceApplication.md | 16 +- .../Get-SPVisioServiceApplicationProxy.md | 16 +- .../Get-SPWOPIBinding.md | 47 ++-- .../Get-SPWOPISuppressionSetting.md | 9 +- .../Get-SPWOPIZone.md | 11 +- .../Get-SPWeb.md | 53 +++-- .../Get-SPWebApplication.md | 23 +- .../Get-SPWebApplicationAppDomain.md | 33 +-- ...t-SPWebApplicationHttpThrottlingMonitor.md | 15 +- .../Get-SPWebPartPack.md | 27 ++- .../Get-SPWebTemplate.md | 23 +- .../Get-SPWebTemplatesEnabledForSiteMaster.md | 8 +- .../Get-SPWorkflowConfig.md | 21 +- .../Get-SPWorkflowServiceApplicationProxy.md | 16 +- ...ant-SPBusinessDataCatalogMetadataObject.md | 41 ++-- .../Grant-SPObjectSecurity.md | 35 +-- .../Import-SPAccessServicesDatabase.md | 28 ++- .../Import-SPAppPackage.md | 49 ++-- ...ort-SPBusinessDataCatalogDotNetAssembly.md | 39 ++-- .../Import-SPBusinessDataCatalogModel.md | 74 ++++-- ...erpriseSearchCustomExtractionDictionary.md | 36 +-- ...Import-SPEnterpriseSearchPopularQueries.md | 42 ++-- .../Import-SPEnterpriseSearchThesaurus.md | 34 ++- .../Import-SPEnterpriseSearchTopology.md | 30 ++- .../Import-SPInfoPathAdministrationFiles.md | 30 ++- ...mport-SPMetadataWebServicePartitionData.md | 52 +++-- .../Import-SPPerformancePointContent.md | 40 ++-- .../Import-SPScaleOutDatabaseTenantData.md | 37 +-- ...port-SPServerScaleOutDatabaseTenantData.md | 32 +-- ...teSubscriptionBusinessDataCatalogConfig.md | 61 +++-- .../Import-SPSiteSubscriptionSettings.md | 42 ++-- .../Import-SPWeb.md | 90 ++++--- .../Initialize-SPResourceSecurity.md | 11 +- .../Initialize-SPStateServiceDatabase.md | 22 +- .../Install-FASTSearchAdminDatabase.md | 38 +-- .../Install-SPApp.md | 31 ++- .../Install-SPApplicationContent.md | 13 +- .../Install-SPDataConnectionFile.md | 42 ++-- .../Install-SPEduSites.md | 29 ++- .../Install-SPFeature.md | 61 +++-- .../Install-SPHelpCollection.md | 23 +- .../Install-SPInfoPathFormTemplate.md | 39 ++-- .../Install-SPService.md | 17 +- .../Install-SPSolution.md | 105 +++++---- .../Install-SPUserSolution.md | 31 ++- .../Install-SPWebPartPack.md | 60 +++-- ...tiveDirectoryEnterpriseResourcePoolSync.md | 16 +- ...nvoke-SPProjectActiveDirectoryGroupSync.md | 16 +- .../Merge-SPLogFile.md | 109 +++++---- .../Merge-SPUsageLog.md | 52 +++-- .../Migrate-SPDatabase.md | 60 +++-- .../Migrate-SPProjectDatabase.md | 54 +++-- .../Migrate-SPProjectResourcePlans.md | 16 +- .../Mount-SPContentDatabase.md | 118 ++++++---- .../Mount-SPSiteMapDatabase.md | 42 ++-- .../Mount-SPStateServiceDatabase.md | 42 ++-- .../Move-SPAppManagementData.md | 43 ++-- .../Move-SPBlobStorageLocation.md | 51 ++-- .../Move-SPDeletedSite.md | 49 ++-- .../Move-SPEnterpriseSearchLinksDatabases.md | 42 ++-- .../Move-SPProfileManagedMetadataProperty.md | 42 ++-- .../Move-SPSite.md | 52 +++-- .../Move-SPSocialComment.md | 42 ++-- .../Move-SPUser.md | 39 ++-- .../New-FASTSearchContentCollection.md | 26 ++- .../New-FASTSearchMetadataCategory.md | 16 +- .../New-FASTSearchMetadataCrawledProperty.md | 26 ++- ...ASTSearchMetadataCrawledPropertyMapping.md | 18 +- .../New-FASTSearchMetadataFullTextIndex.md | 16 +- ...-FASTSearchMetadataFullTextIndexMapping.md | 20 +- .../New-FASTSearchMetadataManagedProperty.md | 24 +- .../New-FASTSearchMetadataRankProfile.md | 16 +- .../New-FASTSearchSearchSettingGroup.md | 10 +- .../New-FASTSearchSecurityClaimsUserStore.md | 30 ++- ...w-FASTSearchSecurityLotusNotesUserStore.md | 78 ++++--- .../New-FASTSearchSecurityRegexAliaser.md | 48 ++-- ...w-FASTSearchSecurityRegexAliaserPattern.md | 28 ++- .../New-FASTSearchSecurityXMLAliaser.md | 36 +-- .../New-SPAccessServiceApplication.md | 134 +++++++---- .../New-SPAccessServicesApplication.md | 135 ++++++----- .../New-SPAccessServicesApplicationProxy.md | 24 +- .../New-SPAccessServicesDatabaseServer.md | 114 +++++---- .../New-SPAlternateURL.md | 49 ++-- .../New-SPAppManagementServiceApplication.md | 61 +++-- ...-SPAppManagementServiceApplicationProxy.md | 43 ++-- .../New-SPAuthenticationProvider.md | 57 +++-- ...ureAccessControlServiceApplicationProxy.md | 37 +-- .../New-SPBECWebServiceApplicationProxy.md | 34 ++- ...SPBusinessDataCatalogServiceApplication.md | 85 ++++--- ...inessDataCatalogServiceApplicationProxy.md | 48 ++-- .../New-SPCentralAdministration.md | 31 +-- .../New-SPClaimProvider.md | 47 ++-- .../New-SPClaimTypeEncoding.md | 38 +-- .../New-SPClaimTypeMapping.md | 34 ++- .../New-SPClaimsPrincipal.md | 82 +++---- .../New-SPConfigurationDatabase.md | 99 +++++--- .../New-SPContentDatabase.md | 85 ++++--- .../New-SPContentDeploymentJob.md | 84 ++++--- .../New-SPContentDeploymentPath.md | 106 ++++++--- .../New-SPEduClass.md | 77 +++--- .../New-SPEnterpriseSearchAdminComponent.md | 35 ++- ...priseSearchAnalyticsProcessingComponent.md | 35 ++- ...iseSearchContentEnrichmentConfiguration.md | 10 +- ...erpriseSearchContentProcessingComponent.md | 36 +-- .../New-SPEnterpriseSearchCrawlComponent.md | 36 +-- ...ew-SPEnterpriseSearchCrawlContentSource.md | 86 +++---- ...-SPEnterpriseSearchCrawlCustomConnector.md | 42 ++-- .../New-SPEnterpriseSearchCrawlDatabase.md | 54 +++-- .../New-SPEnterpriseSearchCrawlExtension.md | 30 ++- .../New-SPEnterpriseSearchCrawlMapping.md | 35 ++- .../New-SPEnterpriseSearchCrawlRule.md | 113 +++++---- .../New-SPEnterpriseSearchFileFormat.md | 48 ++-- .../New-SPEnterpriseSearchIndexComponent.md | 55 +++-- ...PEnterpriseSearchLanguageResourcePhrase.md | 71 +++--- .../New-SPEnterpriseSearchLinksDatabase.md | 57 +++-- .../New-SPEnterpriseSearchMetadataCategory.md | 61 ++--- ...EnterpriseSearchMetadataCrawledProperty.md | 78 ++++--- ...EnterpriseSearchMetadataManagedProperty.md | 132 ++++++----- .../New-SPEnterpriseSearchMetadataMapping.md | 50 ++-- .../New-SPEnterpriseSearchQueryAuthority.md | 39 ++-- .../New-SPEnterpriseSearchQueryDemoted.md | 37 +-- .../New-SPEnterpriseSearchQueryKeyword.md | 63 ++--- ...nterpriseSearchQueryProcessingComponent.md | 39 ++-- .../New-SPEnterpriseSearchQueryScope.md | 67 +++--- .../New-SPEnterpriseSearchQueryScopeRule.md | 59 +++-- .../New-SPEnterpriseSearchRankingModel.md | 37 +-- .../New-SPEnterpriseSearchResultItemType.md | 109 ++++----- .../New-SPEnterpriseSearchResultSource.md | 121 +++++----- .../New-SPEnterpriseSearchSecurityTrimmer.md | 51 ++-- ...ew-SPEnterpriseSearchServiceApplication.md | 85 ++++--- ...EnterpriseSearchServiceApplicationProxy.md | 51 ++-- .../New-SPEnterpriseSearchSiteHitRule.md | 45 ++-- .../New-SPEnterpriseSearchTopology.md | 42 ++-- .../New-SPExcelBIServer.md | 43 ++-- .../New-SPExcelBlockedFileType.md | 35 +-- .../New-SPExcelDataConnectionLibrary.md | 41 ++-- .../New-SPExcelDataProvider.md | 50 ++-- .../New-SPExcelFileLocation.md | 164 ++++++++----- .../New-SPExcelServiceApplication.md | 158 ++++++++----- .../New-SPExcelUserDefinedFunction.md | 53 +++-- .../New-SPLogFile.md | 13 +- .../New-SPManagedAccount.md | 28 ++- .../New-SPManagedPath.md | 45 ++-- ...SPMarketplaceWebServiceApplicationProxy.md | 39 ++-- .../New-SPMetadataServiceApplication.md | 161 ++++++++----- .../New-SPMetadataServiceApplicationProxy.md | 77 +++--- ...ew-SPPerformancePointServiceApplication.md | 215 +++++++++++------ ...PerformancePointServiceApplicationProxy.md | 39 ++-- ...ePointServiceApplicationTrustedLocation.md | 51 ++-- ...PPowerPointConversionServiceApplication.md | 34 +-- ...rPointConversionServiceApplicationProxy.md | 39 ++-- .../New-SPProfileServiceApplication.md | 148 +++++++----- .../New-SPProfileServiceApplicationProxy.md | 51 ++-- .../New-SPProjectServiceApplication.md | 34 +-- .../New-SPProjectServiceApplicationProxy.md | 26 ++- .../New-SPRequestManagementRuleCriteria.md | 42 ++-- .../New-SPSecureStoreApplication.md | 49 ++-- .../New-SPSecureStoreApplicationField.md | 31 +-- .../New-SPSecureStoreServiceApplication.md | 99 +++++--- ...ew-SPSecureStoreServiceApplicationProxy.md | 48 ++-- .../New-SPSecureStoreTargetApplication.md | 49 ++-- .../New-SPServiceApplicationPool.md | 33 +-- .../New-SPServiceApplicationProxyGroup.md | 27 ++- .../New-SPSite.md | 134 +++++++---- .../New-SPSiteMaster.md | 45 ++-- .../New-SPSiteSubscription.md | 21 +- .../New-SPSiteSubscriptionFeaturePack.md | 21 +- .../New-SPStateServiceApplication.md | 24 +- .../New-SPStateServiceApplicationProxy.md | 31 +-- .../New-SPStateServiceDatabase.md | 42 ++-- ...PSubscriptionSettingsServiceApplication.md | 62 +++-- ...criptionSettingsServiceApplicationProxy.md | 32 ++- .../New-SPTranslationServiceApplication.md | 75 +++--- ...ew-SPTranslationServiceApplicationProxy.md | 51 ++-- .../New-SPTrustedIdentityTokenIssuer.md | 105 ++++++--- .../New-SPTrustedRootAuthority.md | 37 +-- .../New-SPTrustedSecurityTokenIssuer.md | 57 +++-- .../New-SPTrustedServiceTokenIssuer.md | 45 ++-- .../New-SPUsageApplication.md | 63 +++-- .../New-SPUsageLogFile.md | 13 +- .../New-SPUser.md | 66 ++++-- .../New-SPUserLicenseMapping.md | 81 ++++--- .../New-SPUserSettingsProvider.md | 31 +-- .../New-SPUserSolutionAllowList.md | 33 +-- .../New-SPVisioSafeDataProvider.md | 37 +-- .../New-SPVisioServiceApplication.md | 39 ++-- .../New-SPVisioServiceApplicationProxy.md | 33 +-- .../New-SPWOPIBinding.md | 65 ++++-- .../New-SPWOPISuppressionSetting.md | 41 ++-- .../New-SPWeb.md | 75 +++--- .../New-SPWebApplication.md | 142 +++++++---- .../New-SPWebApplicationAppDomain.md | 31 +-- .../New-SPWebApplicationExtension.md | 107 ++++++--- .../New-SPWordConversionServiceApplication.md | 63 +++-- .../New-SPWorkManagementServiceApplication.md | 38 +-- ...SPWorkManagementServiceApplicationProxy.md | 45 ++-- .../New-SPWorkflowServiceApplicationProxy.md | 28 ++- .../Pause-SPProjectWebInstance.md | 18 +- .../Publish-SPServiceApplication.md | 39 ++-- ...eive-SPServiceApplicationConnectionInfo.md | 25 +- .../Register-SPAppPrincipal.md | 31 +-- .../Register-SPWorkflowService.md | 48 ++-- .../Remove-DatabaseFromAvailabilityGroup.md | 49 ++-- .../Remove-FASTSearchContentCollection.md | 26 ++- .../Remove-FASTSearchMetadataCategory.md | 30 ++- ...ASTSearchMetadataCrawledPropertyMapping.md | 30 ++- .../Remove-FASTSearchMetadataFullTextIndex.md | 32 ++- ...-FASTSearchMetadataFullTextIndexMapping.md | 8 +- ...emove-FASTSearchMetadataManagedProperty.md | 30 ++- .../Remove-FASTSearchMetadataRankProfile.md | 30 ++- .../Remove-FASTSearchResource.md | 8 +- .../Remove-FASTSearchSearchSettingGroup.md | 28 ++- .../Remove-FASTSearchSecurityAliaser.md | 26 ++- .../Remove-FASTSearchSecurityUserStore.md | 26 ++- .../Remove-SPAccessServicesDatabaseServer.md | 44 ++-- .../Remove-SPActivityFeedItems.md | 55 +++-- .../Remove-SPAlternateURL.md | 30 +-- .../Remove-SPAppDeniedEndpoint.md | 27 ++- .../Remove-SPAppPrincipalPermission.md | 45 ++-- .../Remove-SPApplicationCredentialKey.md | 22 +- .../Remove-SPBusinessDataCatalogModel.md | 27 ++- .../Remove-SPCentralAdministration.md | 21 +- .../Remove-SPClaimProvider.md | 19 +- .../Remove-SPClaimTypeMapping.md | 35 +-- .../Remove-SPConfigurationDatabase.md | 21 +- .../Remove-SPContentDatabase.md | 33 ++- .../Remove-SPContentDeploymentJob.md | 27 ++- .../Remove-SPContentDeploymentPath.md | 27 ++- .../Remove-SPDeletedSite.md | 39 ++-- .../Remove-SPDiagnosticsPerformanceCounter.md | 57 +++-- ...emove-SPDistributedCacheServiceInstance.md | 12 +- .../Remove-SPEduClassMember.md | 30 ++- .../Remove-SPEnterpriseSearchComponent.md | 41 ++-- ...iseSearchContentEnrichmentConfiguration.md | 19 +- ...ve-SPEnterpriseSearchCrawlContentSource.md | 33 +-- ...-SPEnterpriseSearchCrawlCustomConnector.md | 33 +-- .../Remove-SPEnterpriseSearchCrawlDatabase.md | 33 +-- ...Remove-SPEnterpriseSearchCrawlExtension.md | 33 +-- ...PEnterpriseSearchCrawlLogReadPermission.md | 45 ++-- .../Remove-SPEnterpriseSearchCrawlMapping.md | 33 +-- .../Remove-SPEnterpriseSearchCrawlRule.md | 33 +-- .../Remove-SPEnterpriseSearchFileFormat.md | 35 +-- ...PEnterpriseSearchLanguageResourcePhrase.md | 71 +++--- .../Remove-SPEnterpriseSearchLinksDatabase.md | 33 +-- ...move-SPEnterpriseSearchMetadataCategory.md | 35 +-- ...EnterpriseSearchMetadataManagedProperty.md | 49 ++-- ...emove-SPEnterpriseSearchMetadataMapping.md | 37 +-- ...Remove-SPEnterpriseSearchQueryAuthority.md | 35 +-- .../Remove-SPEnterpriseSearchQueryDemoted.md | 37 +-- .../Remove-SPEnterpriseSearchQueryKeyword.md | 33 +-- .../Remove-SPEnterpriseSearchQueryScope.md | 37 +-- ...Remove-SPEnterpriseSearchQueryScopeRule.md | 41 ++-- .../Remove-SPEnterpriseSearchRankingModel.md | 40 ++-- ...Remove-SPEnterpriseSearchResultItemType.md | 42 ++-- .../Remove-SPEnterpriseSearchResultSource.md | 49 ++-- ...emove-SPEnterpriseSearchSecurityTrimmer.md | 33 +-- ...ve-SPEnterpriseSearchServiceApplication.md | 33 +-- ...EnterpriseSearchServiceApplicationProxy.md | 27 ++- ...iseSearchServiceApplicationSiteSettings.md | 39 ++-- .../Remove-SPEnterpriseSearchSiteHitRule.md | 33 +-- ...e-SPEnterpriseSearchTenantConfiguration.md | 29 ++- .../Remove-SPEnterpriseSearchTenantSchema.md | 41 ++-- .../Remove-SPEnterpriseSearchTopology.md | 36 +-- .../Remove-SPExcelBIServer.md | 34 +-- .../Remove-SPExcelBlockedFileType.md | 35 +-- .../Remove-SPExcelDataConnectionLibrary.md | 35 +-- .../Remove-SPExcelDataProvider.md | 27 ++- .../Remove-SPExcelFileLocation.md | 35 +-- .../Remove-SPExcelUserDefinedFunction.md | 33 +-- .../Remove-SPInfoPathUserAgent.md | 25 +- .../Remove-SPManagedAccount.md | 39 ++-- .../Remove-SPManagedPath.md | 42 ++-- ...ve-SPPerformancePointServiceApplication.md | 27 ++- ...PerformancePointServiceApplicationProxy.md | 27 ++- ...ePointServiceApplicationTrustedLocation.md | 27 ++- .../Remove-SPPluggableSecurityTrimmer.md | 36 +-- .../Remove-SPProfileLeader.md | 39 ++-- .../Remove-SPProfileSyncConnection.md | 69 ++++-- .../Remove-SPProjectWebInstanceData.md | 26 ++- .../Remove-SPRoutingMachineInfo.md | 19 +- .../Remove-SPRoutingMachinePool.md | 19 +- .../Remove-SPRoutingRule.md | 19 +- .../Remove-SPScaleOutDatabase.md | 39 ++-- .../Remove-SPSecureStoreApplication.md | 27 ++- .../Remove-SPSecureStoreSystemAccount.md | 30 +-- .../Remove-SPServerScaleOutDatabase.md | 39 ++-- .../Remove-SPServiceApplication.md | 33 +-- .../Remove-SPServiceApplicationPool.md | 27 ++- .../Remove-SPServiceApplicationProxy.md | 32 ++- .../Remove-SPServiceApplicationProxyGroup.md | 27 ++- ...ve-SPServiceApplicationProxyGroupMember.md | 31 ++- .../Remove-SPShellAdmin.md | 33 +-- .../Remove-SPSite.md | 48 ++-- .../Remove-SPSiteMaster.md | 31 ++- .../Remove-SPSiteSubscription.md | 33 +-- ...teSubscriptionBusinessDataCatalogConfig.md | 27 ++- .../Remove-SPSiteSubscriptionFeaturePack.md | 27 ++- ...ove-SPSiteSubscriptionFeaturePackMember.md | 42 ++-- ...Remove-SPSiteSubscriptionMetadataConfig.md | 33 +-- .../Remove-SPSiteSubscriptionProfileConfig.md | 39 ++-- .../Remove-SPSiteSubscriptionSettings.md | 55 +++-- .../Remove-SPSiteURL.md | 27 ++- .../Remove-SPSiteUpgradeSessionInfo.md | 27 ++- .../Remove-SPSocialItemByDate.md | 57 +++-- .../Remove-SPSolution.md | 39 ++-- .../Remove-SPSolutionDeploymentLock.md | 27 ++- .../Remove-SPStateServiceDatabase.md | 25 +- .../Remove-SPThrottlingRule.md | 19 +- .../Remove-SPTranslationServiceJobHistory.md | 57 +++-- .../Remove-SPTrustedIdentityTokenIssuer.md | 27 ++- .../Remove-SPTrustedRootAuthority.md | 25 +- .../Remove-SPTrustedSecurityTokenIssuer.md | 27 ++- .../Remove-SPTrustedServiceTokenIssuer.md | 27 ++- .../Remove-SPUsageApplication.md | 39 ++-- .../Remove-SPUser.md | 40 ++-- .../Remove-SPUserLicenseMapping.md | 27 ++- .../Remove-SPUserSettingsProvider.md | 19 +- .../Remove-SPUserSolution.md | 33 +-- .../Remove-SPVisioSafeDataProvider.md | 32 +-- .../Remove-SPWOPIBinding.md | 77 +++--- .../Remove-SPWOPISuppressionSetting.md | 50 ++-- .../Remove-SPWeb.md | 38 +-- .../Remove-SPWebApplication.md | 48 ++-- .../Remove-SPWebApplicationAppDomain.md | 29 ++- ...emove-SPWordConversionServiceJobHistory.md | 54 +++-- .../Rename-SPServer.md | 31 ++- .../Repair-SPManagedAccountDeployment.md | 21 +- .../Repair-SPProjectWebInstance.md | 25 +- .../Repair-SPSite.md | 42 ++-- .../Request-SPUpgradeEvaluationSite.md | 39 ++-- .../Reset-SPAccessServicesDatabasePassword.md | 31 ++- .../Reset-SPProjectEventServiceSettings.md | 13 +- .../Reset-SPProjectPCSSettings.md | 17 +- .../Reset-SPProjectQueueSettings.md | 17 +- .../Reset-SPSites.md | 26 ++- .../Restart-SPAppInstanceJob.md | 24 +- .../Restore-SPDeletedSite.md | 39 ++-- ...re-SPEnterpriseSearchServiceApplication.md | 93 +++++--- ...EnterpriseSearchServiceApplicationIndex.md | 69 +++--- .../Restore-SPFarm.md | 99 +++++--- .../Restore-SPSite.md | 83 ++++--- ...me-SPEnterpriseSearchServiceApplication.md | 25 +- .../Resume-SPProjectWebInstance.md | 17 +- .../Resume-SPStateServiceDatabase.md | 25 +- ...oke-SPBusinessDataCatalogMetadataObject.md | 45 ++-- .../Revoke-SPObjectSecurity.md | 37 +-- .../Set-FASTSearchConfiguration.md | 8 +- .../Set-FASTSearchIPSec.md | 32 ++- .../Set-FASTSearchMetadataCategory.md | 32 ++- .../Set-FASTSearchMetadataCrawledProperty.md | 30 ++- ...ASTSearchMetadataCrawledPropertyMapping.md | 18 +- .../Set-FASTSearchMetadataFullTextIndex.md | 26 ++- ...-FASTSearchMetadataFullTextIndexMapping.md | 10 +- .../Set-FASTSearchMetadataManagedProperty.md | 82 ++++--- .../Set-FASTSearchMetadataRankProfile.md | 74 +++--- .../Set-FASTSearchSecurityCCTKServer.md | 20 +- .../Set-FASTSearchSecurityClaimsUserStore.md | 28 ++- .../Set-FASTSearchSecurityDefaultUserStore.md | 16 +- .../Set-FASTSearchSecurityLogLevel.md | 46 ++-- ...t-FASTSearchSecurityLotusNotesUserStore.md | 76 +++--- .../Set-FASTSearchSecurityPublicFilter.md | 16 +- .../Set-FASTSearchSecurityRegexAliaser.md | 46 ++-- .../Set-FASTSearchSecurityXMLAliaser.md | 40 ++-- .../Set-SPAccessServiceApplication.md | 127 ++++++---- .../Set-SPAccessServicesApplication.md | 61 +++-- .../Set-SPAccessServicesDatabaseServer.md | 104 ++++++--- ...ccessServicesDatabaseServerGroupMapping.md | 67 ++++-- .../Set-SPAlternateURL.md | 46 ++-- .../Set-SPAppAcquisitionConfiguration.md | 44 ++-- .../Set-SPAppAutoProvisionConnection.md | 56 +++-- .../Set-SPAppDisablingConfiguration.md | 29 +-- .../Set-SPAppDomain.md | 25 +- .../Set-SPAppHostingQuotaConfiguration.md | 44 ++-- .../Set-SPAppManagementDeploymentId.md | 38 +-- .../Set-SPAppPrincipalPermission.md | 48 ++-- .../Set-SPAppScaleProfile.md | 23 +- .../Set-SPAppSiteDomain.md | 29 +-- .../Set-SPAppSiteSubscriptionName.md | 40 ++-- .../Set-SPAppStateUpdateInterval.md | 31 ++- .../Set-SPAppStoreConfiguration.md | 39 ++-- .../Set-SPAppStoreWebServiceConfiguration.md | 30 ++- .../Set-SPApplicationCredentialKey.md | 25 +- .../Set-SPAuthenticationRealm.md | 31 ++- .../Set-SPBingMapsBlock.md | 25 +- .../Set-SPBingMapsKey.md | 25 +- ...serCustomerExperienceImprovementProgram.md | 49 ++-- ...usinessDataCatalogEntityNotificationWeb.md | 25 +- ...Set-SPBusinessDataCatalogMetadataObject.md | 55 +++-- ...SPBusinessDataCatalogServiceApplication.md | 79 ++++--- ...Set-SPBusinessDataCatalogThrottleConfig.md | 43 ++-- .../Set-SPCentralAdministration.md | 31 ++- .../Set-SPClaimProvider.md | 29 ++- .../Set-SPContentDatabase.md | 52 +++-- .../Set-SPContentDeploymentJob.md | 85 ++++--- .../Set-SPContentDeploymentPath.md | 91 +++++--- .../Set-SPCustomLayoutsPage.md | 49 ++-- .../Set-SPDataConnectionFile.md | 58 +++-- .../Set-SPDefaultProfileConfig.md | 31 ++- .../Set-SPDesignerSettings.md | 81 ++++--- .../Set-SPDiagnosticConfig.md | 136 +++++++---- .../Set-SPDiagnosticsProvider.md | 46 ++-- .../Set-SPDistributedCacheClientSetting.md | 24 +- .../Set-SPEduServiceSetting.md | 49 ++-- ...EnterpriseSearchAdministrationComponent.md | 51 ++-- ...iseSearchContentEnrichmentConfiguration.md | 42 ++-- ...et-SPEnterpriseSearchCrawlContentSource.md | 180 +++++++------- .../Set-SPEnterpriseSearchCrawlDatabase.md | 62 +++-- ...PEnterpriseSearchCrawlLogReadPermission.md | 43 ++-- .../Set-SPEnterpriseSearchCrawlRule.md | 109 +++++---- .../Set-SPEnterpriseSearchFileFormatState.md | 46 ++-- ...erpriseSearchLinguisticComponentsStatus.md | 64 ++--- .../Set-SPEnterpriseSearchLinksDatabase.md | 61 +++-- .../Set-SPEnterpriseSearchMetadataCategory.md | 56 +++-- ...EnterpriseSearchMetadataCrawledProperty.md | 34 +-- ...EnterpriseSearchMetadataManagedProperty.md | 125 +++++----- .../Set-SPEnterpriseSearchMetadataMapping.md | 55 +++-- ...SPEnterpriseSearchPrimaryHostController.md | 37 +-- .../Set-SPEnterpriseSearchQueryAuthority.md | 45 ++-- .../Set-SPEnterpriseSearchQueryKeyword.md | 66 +++--- .../Set-SPEnterpriseSearchQueryScope.md | 67 +++--- .../Set-SPEnterpriseSearchQueryScopeRule.md | 59 +++-- ...EnterpriseSearchQuerySpellingCorrection.md | 77 +++--- .../Set-SPEnterpriseSearchRankingModel.md | 43 ++-- .../Set-SPEnterpriseSearchResultItemType.md | 73 ++++-- .../Set-SPEnterpriseSearchResultSource.md | 131 ++++++----- .../Set-SPEnterpriseSearchService.md | 89 ++++--- ...et-SPEnterpriseSearchServiceApplication.md | 117 +++++----- ...EnterpriseSearchServiceApplicationProxy.md | 31 ++- .../Set-SPEnterpriseSearchServiceInstance.md | 35 +-- .../Set-SPEnterpriseSearchTopology.md | 33 +-- .../Set-SPExcelBIServer.md | 41 ++-- .../Set-SPExcelDataConnectionLibrary.md | 46 ++-- .../Set-SPExcelDataProvider.md | 47 ++-- .../Set-SPExcelFileLocation.md | 168 ++++++++----- .../Set-SPExcelServiceApplication.md | 150 +++++++----- .../Set-SPExcelUserDefinedFunction.md | 61 +++-- .../Set-SPFarmConfig.md | 108 ++++++--- .../Set-SPIRMSettings.md | 67 ++++-- .../Set-SPInfoPathFormTemplate.md | 31 ++- .../Set-SPInfoPathFormsService.md | 134 +++++++---- .../Set-SPInfoPathWebServiceProxy.md | 37 +-- .../Set-SPInternalAppStateUpdateInterval.md | 25 +- .../Set-SPLogLevel.md | 44 ++-- .../Set-SPManagedAccount.md | 84 ++++--- .../Set-SPMetadataServiceApplication.md | 154 +++++++----- .../Set-SPMetadataServiceApplicationProxy.md | 67 +++--- .../Set-SPMicrofeedOptions.md | 56 +++-- .../Set-SPMobileMessagingAccount.md | 45 ++-- .../Set-SPO365LinkSettings.md | 29 ++- .../Set-SPOfficeStoreAppsDefaultActivation.md | 37 +-- .../Set-SPPassPhrase.md | 37 +-- .../Set-SPPerformancePointSecureDataValues.md | 30 ++- ...et-SPPerformancePointServiceApplication.md | 220 ++++++++++++------ ...PPowerPointConversionServiceApplication.md | 50 ++-- .../Set-SPProfileServiceApplication.md | 121 ++++++---- .../Set-SPProfileServiceApplicationProxy.md | 55 +++-- ...Set-SPProfileServiceApplicationSecurity.md | 42 ++-- .../Set-SPProjectDatabaseQuota.md | 46 ++-- .../Set-SPProjectEventServiceSettings.md | 15 +- .../Set-SPProjectOdataConfiguration.md | 73 +++--- .../Set-SPProjectPCSSettings.md | 68 ++++-- .../Set-SPProjectPermissionMode.md | 24 +- .../Set-SPProjectQueueSettings.md | 86 ++++--- .../Set-SPProjectServiceApplication.md | 21 +- .../Set-SPProjectUserSync.md | 21 +- ...-SPProjectUserSyncDisabledSyncThreshold.md | 21 +- .../Set-SPProjectUserSyncFullSyncThreshold.md | 21 +- ...t-SPProjectUserSyncOffPeakSyncThreshold.md | 21 +- .../Set-SPRequestManagementSettings.md | 33 ++- .../Set-SPRoutingMachineInfo.md | 46 ++-- .../Set-SPRoutingMachinePool.md | 21 +- .../Set-SPRoutingRule.md | 41 ++-- .../Set-SPScaleOutDatabaseDataRange.md | 43 ++-- .../Set-SPScaleOutDatabaseDataSubRange.md | 67 ++++-- .../Set-SPSecureStoreApplication.md | 55 +++-- .../Set-SPSecureStoreDefaultProvider.md | 17 +- .../Set-SPSecureStoreServiceApplication.md | 85 ++++--- .../Set-SPSecurityTokenServiceConfig.md | 125 +++++----- .../Set-SPServer.md | 34 +-- .../Set-SPServerScaleOutDatabaseDataRange.md | 51 ++-- ...et-SPServerScaleOutDatabaseDataSubRange.md | 78 ++++--- .../Set-SPServiceApplication.md | 43 ++-- .../Set-SPServiceApplicationEndpoint.md | 37 +-- .../Set-SPServiceApplicationPool.md | 31 ++- .../Set-SPServiceApplicationSecurity.md | 29 ++- .../Set-SPServiceHostConfig.md | 63 +++-- .../Set-SPSessionStateService.md | 31 ++- .../Set-SPSite.md | 106 ++++++--- .../Set-SPSiteAdministration.md | 80 ++++--- .../Set-SPSiteSubscriptionConfig.md | 43 ++-- .../Set-SPSiteSubscriptionEdiscoveryHub.md | 31 ++- .../Set-SPSiteSubscriptionIRMConfig.md | 46 ++-- .../Set-SPSiteSubscriptionMetadataConfig.md | 49 ++-- .../Set-SPSiteSubscriptionProfileConfig.md | 68 +++--- .../Set-SPSiteURL.md | 38 +-- .../Set-SPStateServiceApplication.md | 31 ++- .../Set-SPStateServiceApplicationProxy.md | 30 ++- .../Set-SPStateServiceDatabase.md | 44 ++-- ...PSubscriptionSettingsServiceApplication.md | 49 ++-- .../Set-SPThrottlingRule.md | 35 +-- .../Set-SPTimerJob.md | 30 ++- .../Set-SPTopologyServiceApplication.md | 31 ++- .../Set-SPTopologyServiceApplicationProxy.md | 31 ++- .../Set-SPTranslationServiceApplication.md | 197 ++++++++++------ ...et-SPTranslationServiceApplicationProxy.md | 40 ++-- .../Set-SPTranslationThrottlingSetting.md | 34 +-- .../Set-SPTrustedIdentityTokenIssuer.md | 81 ++++--- .../Set-SPTrustedRootAuthority.md | 37 +-- .../Set-SPTrustedSecurityTokenIssuer.md | 55 +++-- .../Set-SPTrustedServiceTokenIssuer.md | 46 ++-- .../Set-SPUsageApplication.md | 67 ++++-- .../Set-SPUsageDefinition.md | 55 +++-- .../Set-SPUsageService.md | 56 +++-- .../Set-SPUser.md | 87 ++++--- .../Set-SPVisioExternalData.md | 21 +- .../Set-SPVisioPerformance.md | 50 ++-- .../Set-SPVisioSafeDataProvider.md | 37 +-- .../Set-SPVisioServiceApplication.md | 33 +-- .../Set-SPWOPIBinding.md | 31 ++- .../Set-SPWOPIZone.md | 25 +- .../Set-SPWeb.md | 48 ++-- .../Set-SPWebApplication.md | 116 +++++---- ...t-SPWebApplicationHttpThrottlingMonitor.md | 63 +++-- .../Set-SPWordConversionServiceApplication.md | 144 ++++++++---- .../Set-SPWorkManagementServiceApplication.md | 72 ++++-- ...SPWorkManagementServiceApplicationProxy.md | 35 ++- .../Set-SPWorkflowConfig.md | 46 ++-- .../Split-SPScaleOutDatabase.md | 73 ++++-- .../Split-SPServerScaleOutDatabase.md | 84 ++++--- .../Start-SPAdminJob.md | 19 +- .../Start-SPAssignment.md | 19 +- .../Start-SPContentDeploymentJob.md | 47 ++-- .../Start-SPDiagnosticsSession.md | 30 +-- ...archQueryAndSiteSettingsServiceInstance.md | 25 +- ...Start-SPEnterpriseSearchServiceInstance.md | 24 +- .../Start-SPInfoPathFormTemplate.md | 24 +- .../Start-SPProjectGenerateWsdl.md | 15 +- .../Start-SPService.md | 31 ++- .../Start-SPServiceInstance.md | 24 +- .../Start-SPTimerJob.md | 23 +- .../Stop-SPAssignment.md | 23 +- .../Stop-SPContentTypeReplication.md | 8 +- .../Stop-SPDiagnosticsSession.md | 10 +- .../Stop-SPDistributedCacheServiceInstance.md | 15 +- ...archQueryAndSiteSettingsServiceInstance.md | 23 +- .../Stop-SPEnterpriseSearchServiceInstance.md | 26 ++- .../Stop-SPInfoPathFormTemplate.md | 28 ++- .../Stop-SPService.md | 35 +-- .../Stop-SPServiceInstance.md | 23 +- .../Stop-SPTaxonomyReplication.md | 14 +- ...nd-SPEnterpriseSearchServiceApplication.md | 22 +- .../Suspend-SPStateServiceDatabase.md | 20 +- .../Sync-SPProjectPermissions.md | 38 +-- .../Test-SPContentDatabase.md | 60 +++-- .../Test-SPInfoPathFormTemplate.md | 14 +- .../Test-SPO365LinkSettings.md | 15 +- .../Test-SPProjectServiceApplication.md | 20 +- .../Test-SPProjectWebInstance.md | 20 +- .../Test-SPSite.md | 29 ++- .../Uninstall-FASTSearchAdminDatabase.md | 20 +- .../Uninstall-SPAppInstance.md | 26 ++- .../Uninstall-SPDataConnectionFile.md | 22 +- .../Uninstall-SPFeature.md | 38 +-- .../Uninstall-SPHelpCollection.md | 23 +- .../Uninstall-SPInfoPathFormTemplate.md | 23 +- .../Uninstall-SPSolution.md | 60 +++-- .../Uninstall-SPUserSolution.md | 29 ++- .../Uninstall-SPWebPartPack.md | 43 ++-- .../Unpublish-SPServiceApplication.md | 23 +- .../Update-SPAppCatalogConfiguration.md | 38 +-- .../Update-SPAppInstance.md | 31 ++- .../Update-SPDistributedCacheSize.md | 16 +- .../Update-SPFarmEncryptionKey.md | 23 +- .../Update-SPHelp.md | 20 +- .../Update-SPInfoPathAdminFileUrl.md | 36 ++- .../Update-SPInfoPathFormTemplate.md | 16 +- .../Update-SPInfoPathUserFileUrl.md | 53 +++-- .../Update-SPProfilePhotoStore.md | 38 +-- .../Update-SPRepopulateMicroblogFeedCache.md | 48 ++-- .../Update-SPRepopulateMicroblogLMTCache.md | 15 +- ...pdate-SPSecureStoreApplicationServerKey.md | 20 +- .../Update-SPSecureStoreCredentialMapping.md | 34 ++- ...ate-SPSecureStoreGroupCredentialMapping.md | 28 ++- .../Update-SPSecureStoreMasterKey.md | 22 +- .../Update-SPSolution.md | 65 ++++-- .../Update-SPUserSolution.md | 35 ++- .../Update-SPWOPIProofKey.md | 15 +- ...grade-SPAppManagementServiceApplication.md | 35 ++- .../Upgrade-SPContentDatabase.md | 84 ++++--- ...de-SPEnterpriseSearchServiceApplication.md | 26 ++- ...iseSearchServiceApplicationSiteSettings.md | 23 +- .../Upgrade-SPFarm.md | 33 ++- .../Upgrade-SPProfileServiceApplication.md | 22 +- .../Upgrade-SPSingleSignOnDatabase.md | 26 ++- .../Upgrade-SPSite.md | 56 +++-- .../Upgrade-SPSiteMapDatabase.md | 22 +- .../Add-SPAppDeniedEndpoint.md | 23 +- .../Add-SPCertificateNotificationContact.md | 2 +- .../Add-SPClaimTypeMapping.md | 31 ++- .../Add-SPDatabaseToAvailabilityGroup.md | 42 ++-- .../Add-SPDiagnosticsPerformanceCounter.md | 90 ++++--- .../Add-SPDistributedCacheServiceInstance.md | 24 +- .../Add-SPInfoPathUserAgent.md | 22 +- ...eoplePickerDistributionListSearchDomain.md | 26 ++- .../Add-SPPeoplePickerSearchADDomain.md | 40 +++- ...PeoplePickerServiceAccountDirectoryPath.md | 26 ++- .../Add-SPPluggableSecurityTrimmer.md | 40 ++-- .../SharePointServer/Add-SPProfileLeader.md | 34 ++- .../Add-SPProfileSyncConnection.md | 108 ++++++--- .../Add-SPRoutingMachineInfo.md | 45 ++-- .../Add-SPRoutingMachinePool.md | 27 ++- .../SharePointServer/Add-SPRoutingRule.md | 45 ++-- .../Add-SPScaleOutDatabase.md | 53 +++-- .../Add-SPSecureStoreSystemAccount.md | 22 +- .../Add-SPServerScaleOutDatabase.md | 48 ++-- ...dd-SPServiceApplicationProxyGroupMember.md | 27 ++- .../SharePointServer/Add-SPShellAdmin.md | 35 +-- ...Add-SPSiteSubscriptionFeaturePackMember.md | 29 ++- .../Add-SPSiteSubscriptionProfileConfig.md | 65 +++--- .../SharePointServer/Add-SPSolution.md | 28 ++- .../SharePointServer/Add-SPThrottlingRule.md | 39 ++-- .../Add-SPUserLicenseMapping.md | 23 +- .../SharePointServer/Add-SPUserSolution.md | 29 ++- .../Backup-SPConfigurationDatabase.md | 47 ++-- ...EnterpriseSearchServiceApplicationIndex.md | 79 ++++--- .../SharePointServer/Backup-SPFarm.md | 71 ++++-- .../SharePointServer/Backup-SPSite.md | 60 +++-- .../Clear-SPAppDeniedEndpointList.md | 19 +- ...usinessDataCatalogEntityNotificationWeb.md | 23 +- .../Clear-SPCertificateNotificationContact.md | 2 +- .../Clear-SPContentDatabaseSyncData.md | 24 +- .../Clear-SPDistributedCacheItem.md | 23 +- .../SharePointServer/Clear-SPLogLevel.md | 27 ++- ...Clear-SPMetadataWebServicePartitionData.md | 38 +-- ...eoplePickerDistributionListSearchDomain.md | 18 +- .../Clear-SPPeoplePickerSearchADDomain.md | 18 +- ...PeoplePickerServiceAccountDirectoryPath.md | 18 +- ...r-SPScaleOutDatabaseDeletedDataSubRange.md | 35 ++- .../Clear-SPScaleOutDatabaseLog.md | 28 ++- .../Clear-SPScaleOutDatabaseTenantData.md | 29 ++- .../Clear-SPSecureStoreCredentialMapping.md | 40 ++-- .../Clear-SPSecureStoreDefaultProvider.md | 8 +- ...rverScaleOutDatabaseDeletedDataSubRange.md | 31 +-- .../Clear-SPServerScaleOutDatabaseLog.md | 25 +- ...lear-SPServerScaleOutDatabaseTenantData.md | 24 +- ...teSubscriptionBusinessDataCatalogConfig.md | 23 +- .../Connect-SPConfigurationDatabase.md | 61 +++-- .../Convert-SPWebApplication.md | 89 ++++--- .../Copy-SPActivitiesToWorkflowService.md | 46 ++-- ...Copy-SPBusinessDataCatalogAclToChildren.md | 23 +- .../SharePointServer/Copy-SPContentTypes.md | 56 +++-- .../Copy-SPSideBySideFiles.md | 16 +- .../SharePointServer/Copy-SPSite.md | 39 ++-- .../SharePointServer/Copy-SPTaxonomyGroups.md | 49 ++-- .../Disable-ProjectServerLicense.md | 10 +- .../Disable-SPAppAutoProvision.md | 17 +- .../Disable-SPBusinessDataCatalogEntity.md | 23 +- .../SharePointServer/Disable-SPFeature.md | 37 +-- .../Disable-SPHealthAnalysisRule.md | 23 +- .../Disable-SPInfoPathFormTemplate.md | 26 ++- ...tiveDirectoryEnterpriseResourcePoolSync.md | 16 +- .../Disable-SPProjectEmailNotification.md | 16 +- ...able-SPProjectEnterpriseProjectTaskSync.md | 16 +- .../Disable-SPProjectQueueStatsMonitoring.md | 10 +- .../Disable-SPSessionStateService.md | 16 +- .../Disable-SPSingleSignOn.md | 22 +- .../SharePointServer/Disable-SPTimerJob.md | 23 +- .../Disable-SPUserLicensing.md | 17 +- .../Disable-SPUserSolutionAllowList.md | 16 +- .../Disable-SPWebApplicationHttpThrottling.md | 23 +- .../Disable-SPWebTemplateForSiteMaster.md | 22 +- .../Disconnect-SPConfigurationDatabase.md | 17 +- .../Dismount-SPContentDatabase.md | 25 +- .../Dismount-SPStateServiceDatabase.md | 22 +- .../Enable-ProjectServerLicense.md | 16 +- .../Enable-SPAppAutoProvision.md | 16 +- .../Enable-SPBusinessDataCatalogEntity.md | 23 +- .../SharePointServer/Enable-SPFeature.md | 50 ++-- .../Enable-SPHealthAnalysisRule.md | 15 +- .../Enable-SPInfoPathFormTemplate.md | 26 ++- ...tiveDirectoryEnterpriseResourcePoolSync.md | 20 +- .../Enable-SPProjectEmailNotification.md | 16 +- ...able-SPProjectEnterpriseProjectTaskSync.md | 16 +- .../Enable-SPProjectQueueStatsMonitoring.md | 10 +- .../Enable-SPSessionStateService.md | 48 ++-- .../SharePointServer/Enable-SPTimerJob.md | 23 +- .../Enable-SPUserLicensing.md | 17 +- .../Enable-SPUserSolutionAllowList.md | 16 +- .../Enable-SPWebApplicationHttpThrottling.md | 23 +- .../Enable-SPWebTemplateForSiteMaster.md | 22 +- .../SharePointServer/Export-SPAppPackage.md | 20 +- .../Export-SPBusinessDataCatalogModel.md | 65 ++++-- .../Export-SPCacheClusterConfig.md | 18 +- .../SharePointServer/Export-SPCertificate.md | 10 +- .../Export-SPEnterpriseSearchTopology.md | 28 ++- .../Export-SPInfoPathAdministrationFiles.md | 28 ++- ...xport-SPMetadataWebServicePartitionData.md | 32 ++- .../Export-SPScaleOutDatabaseTenantData.md | 41 ++-- ...port-SPServerScaleOutDatabaseTenantData.md | 41 ++-- ...teSubscriptionBusinessDataCatalogConfig.md | 65 ++++-- .../Export-SPSiteSubscriptionSettings.md | 36 +-- .../Export-SPTagsAndNotesData.md | 22 +- .../SharePointServer/Export-SPWeb.md | 100 +++++--- .../Get-ProjectServerLicense.md | 10 +- .../SharePointServer/Get-SPAlternateURL.md | 35 +-- .../Get-SPAppAcquisitionConfiguration.md | 20 +- .../Get-SPAppAutoProvisionConnection.md | 23 +- .../Get-SPAppDeniedEndpointList.md | 10 +- .../Get-SPAppDisablingConfiguration.md | 9 +- .../SharePointServer/Get-SPAppDomain.md | 9 +- .../Get-SPAppHostingQuotaConfiguration.md | 21 +- .../SharePointServer/Get-SPAppInstance.md | 40 ++-- .../SharePointServer/Get-SPAppPrincipal.md | 21 +- .../SharePointServer/Get-SPAppScaleProfile.md | 7 +- .../Get-SPAppSiteSubscriptionName.md | 17 +- .../Get-SPAppStateSyncLastRunTime.md | 9 +- .../Get-SPAppStateUpdateInterval.md | 8 +- .../Get-SPAppStoreConfiguration.md | 7 +- .../Get-SPAppStoreWebServiceConfiguration.md | 10 +- .../Get-SPAuthenticationProvider.md | 29 ++- .../Get-SPAuthenticationRealm.md | 14 +- .../Get-SPAvailabilityGroupStatus.md | 18 +- .../SharePointServer/Get-SPBackupHistory.md | 31 ++- .../SharePointServer/Get-SPBingMapsBlock.md | 9 +- .../SharePointServer/Get-SPBingMapsKey.md | 9 +- ...serCustomerExperienceImprovementProgram.md | 29 ++- ...usinessDataCatalogEntityNotificationWeb.md | 15 +- ...Get-SPBusinessDataCatalogMetadataObject.md | 39 ++-- ...Get-SPBusinessDataCatalogThrottleConfig.md | 33 ++- .../SharePointServer/Get-SPCache.md | 14 +- .../Get-SPCacheClusterHealth.md | 14 +- .../Get-SPCacheClusterInfo.md | 14 +- .../SharePointServer/Get-SPCacheHost.md | 22 +- .../SharePointServer/Get-SPCacheHostConfig.md | 18 +- .../SharePointServer/Get-SPCacheStatistics.md | 18 +- .../SharePointServer/Get-SPCertificate.md | 4 +- .../Get-SPCertificateAuthority.md | 2 +- .../Get-SPCertificateNotificationContact.md | 2 +- .../Get-SPCertificateSettings.md | 2 +- .../SharePointServer/Get-SPClaimProvider.md | 15 +- .../Get-SPClaimProviderManager.md | 9 +- .../Get-SPClaimTypeEncoding.md | 25 +- ...PConnectedServiceApplicationInformation.md | 16 +- .../SharePointServer/Get-SPContentDatabase.md | 62 +++-- .../Get-SPContentDatabaseOrphanedData.md | 19 +- .../Get-SPContentDeploymentJob.md | 20 +- .../Get-SPContentDeploymentPath.md | 14 +- .../Get-SPCustomLayoutsPage.md | 27 ++- .../Get-SPDataConnectionFile.md | 18 +- .../Get-SPDataConnectionFileDependent.md | 14 +- .../SharePointServer/Get-SPDatabase.md | 29 ++- .../SharePointServer/Get-SPDeletedSite.md | 63 +++-- .../Get-SPDesignerSettings.md | 15 +- .../Get-SPDiagnosticConfig.md | 9 +- .../Get-SPDiagnosticsPerformanceCounter.md | 25 +- .../Get-SPDiagnosticsProvider.md | 17 +- .../Get-SPDistributedCacheClientSetting.md | 15 +- ...EnterpriseSearchAdministrationComponent.md | 14 +- .../Get-SPEnterpriseSearchComponent.md | 29 ++- ...iseSearchContentEnrichmentConfiguration.md | 15 +- ...et-SPEnterpriseSearchCrawlContentSource.md | 20 +- ...-SPEnterpriseSearchCrawlCustomConnector.md | 20 +- .../Get-SPEnterpriseSearchCrawlDatabase.md | 20 +- .../Get-SPEnterpriseSearchCrawlExtension.md | 20 +- ...PEnterpriseSearchCrawlLogReadPermission.md | 20 +- .../Get-SPEnterpriseSearchCrawlMapping.md | 18 +- .../Get-SPEnterpriseSearchCrawlRule.md | 24 +- .../Get-SPEnterpriseSearchFileFormat.md | 23 +- .../Get-SPEnterpriseSearchHostController.md | 16 +- ...PEnterpriseSearchLanguageResourcePhrase.md | 48 ++-- ...erpriseSearchLinguisticComponentsStatus.md | 20 +- .../Get-SPEnterpriseSearchLinksDatabase.md | 20 +- .../Get-SPEnterpriseSearchMetadataCategory.md | 32 ++- ...EnterpriseSearchMetadataCrawledProperty.md | 40 ++-- ...EnterpriseSearchMetadataManagedProperty.md | 38 +-- .../Get-SPEnterpriseSearchMetadataMapping.md | 38 +-- .../Get-SPEnterpriseSearchOwner.md | 24 +- .../Get-SPEnterpriseSearchPropertyRule.md | 20 +- ...PEnterpriseSearchPropertyRuleCollection.md | 8 +- ...rpriseSearchQueryAndSiteSettingsService.md | 8 +- ...archQueryAndSiteSettingsServiceInstance.md | 22 +- ...eSearchQueryAndSiteSettingsServiceProxy.md | 8 +- .../Get-SPEnterpriseSearchQueryAuthority.md | 26 ++- .../Get-SPEnterpriseSearchQueryDemoted.md | 24 +- .../Get-SPEnterpriseSearchQueryKeyword.md | 20 +- .../Get-SPEnterpriseSearchQueryScope.md | 24 +- .../Get-SPEnterpriseSearchQueryScopeRule.md | 30 ++- ...EnterpriseSearchQuerySpellingCorrection.md | 19 +- ...terpriseSearchQuerySuggestionCandidates.md | 24 +- .../Get-SPEnterpriseSearchRankingModel.md | 26 ++- .../Get-SPEnterpriseSearchResultItemType.md | 33 ++- .../Get-SPEnterpriseSearchResultSource.md | 29 ++- .../Get-SPEnterpriseSearchSecurityTrimmer.md | 20 +- .../Get-SPEnterpriseSearchService.md | 8 +- ...et-SPEnterpriseSearchServiceApplication.md | 14 +- ...riseSearchServiceApplicationBackupStore.md | 50 ++-- ...EnterpriseSearchServiceApplicationProxy.md | 14 +- .../Get-SPEnterpriseSearchServiceInstance.md | 22 +- .../Get-SPEnterpriseSearchSiteHitRule.md | 20 +- .../Get-SPEnterpriseSearchStatus.md | 81 ++++--- .../Get-SPEnterpriseSearchTopology.md | 30 ++- .../Get-SPEnterpriseSearchVssDataPath.md | 13 +- .../SharePointServer/Get-SPFarm.md | 9 +- .../SharePointServer/Get-SPFarmConfig.md | 17 +- .../SharePointServer/Get-SPFeature.md | 59 +++-- .../SharePointServer/Get-SPFlightsInfo.md | 18 +- .../Get-SPHealthAnalysisRule.md | 15 +- .../SharePointServer/Get-SPHelpCollection.md | 15 +- .../SharePointServer/Get-SPIRMSettings.md | 9 +- .../Get-SPInfoPathFormTemplate.md | 16 +- .../Get-SPInfoPathFormsService.md | 14 +- .../Get-SPInfoPathUserAgent.md | 14 +- .../Get-SPInfoPathWebServiceProxy.md | 14 +- .../Get-SPInternalAppStateSyncLastRunTime.md | 9 +- .../Get-SPInternalAppStateUpdateInterval.md | 9 +- .../SharePointServer/Get-SPLogEvent.md | 61 +++-- .../SharePointServer/Get-SPLogLevel.md | 21 +- .../SharePointServer/Get-SPManagedAccount.md | 33 ++- .../SharePointServer/Get-SPManagedPath.md | 31 ++- .../Get-SPMetadataServiceApplication.md | 14 +- .../Get-SPMetadataServiceApplicationProxy.md | 14 +- .../Get-SPMicrofeedOptions.md | 22 +- .../Get-SPMobileMessagingAccount.md | 19 +- .../Get-SPO365LinkSettings.md | 8 +- .../Get-SPODataConnectionSetting.md | 30 +-- .../Get-SPODataConnectionSettingMetadata.md | 28 +-- .../Get-SPOfficeStoreAppsDefaultActivation.md | 29 +-- .../Get-SPPendingUpgradeActions.md | 27 ++- .../Get-SPPeoplePickerConfig.md | 18 +- ...eoplePickerDistributionListSearchDomain.md | 24 +- .../Get-SPPeoplePickerSearchADDomain.md | 28 ++- .../Get-SPPluggableSecurityTrimmer.md | 14 +- .../SharePointServer/Get-SPProcessAccount.md | 29 ++- .../SharePointServer/Get-SPProduct.md | 21 +- .../SharePointServer/Get-SPProfileLeader.md | 20 +- ...Get-SPProfileServiceApplicationSecurity.md | 26 ++- .../Get-SPProjectDatabaseQuota.md | 16 +- .../Get-SPProjectDatabaseUsage.md | 16 +- .../Get-SPProjectEnterpriseProjectTaskSync.md | 16 +- .../Get-SPProjectEventServiceSettings.md | 10 +- ...Get-SPProjectIsEmailNotificationEnabled.md | 16 +- .../Get-SPProjectOdataConfiguration.md | 14 +- .../Get-SPProjectPCSSettings.md | 14 +- .../Get-SPProjectPermissionMode.md | 16 +- .../Get-SPProjectQueueSettings.md | 14 +- .../Get-SPProjectWebInstance.md | 20 +- .../Get-SPRemoteShareBlobStore.md | 30 ++- .../Get-SPRequestManagementSettings.md | 15 +- .../Get-SPRoutingMachineInfo.md | 27 ++- .../Get-SPRoutingMachinePool.md | 21 +- .../SharePointServer/Get-SPRoutingRule.md | 21 +- .../Get-SPScaleOutDatabase.md | 23 +- .../Get-SPScaleOutDatabaseDataState.md | 35 ++- .../Get-SPScaleOutDatabaseInconsistency.md | 23 +- .../Get-SPScaleOutDatabaseLogEntry.md | 47 ++-- .../Get-SPSecureStoreApplication.md | 28 ++- .../Get-SPSecureStoreSystemAccount.md | 8 +- .../Get-SPSecurityTokenServiceConfig.md | 9 +- .../SharePointServer/Get-SPServer.md | 15 +- .../Get-SPServerScaleOutDatabase.md | 27 +-- .../Get-SPServerScaleOutDatabaseDataState.md | 39 ++-- ...t-SPServerScaleOutDatabaseInconsistency.md | 24 +- .../Get-SPServerScaleOutDatabaseLogEntry.md | 51 ++-- .../SharePointServer/Get-SPService.md | 22 +- .../Get-SPServiceApplication.md | 25 +- .../Get-SPServiceApplicationEndpoint.md | 27 ++- .../Get-SPServiceApplicationPool.md | 15 +- .../Get-SPServiceApplicationProxy.md | 15 +- .../Get-SPServiceApplicationProxyGroup.md | 21 +- .../Get-SPServiceApplicationSecurity.md | 21 +- .../SharePointServer/Get-SPServiceContext.md | 21 +- .../Get-SPServiceHostConfig.md | 15 +- .../SharePointServer/Get-SPServiceInstance.md | 27 ++- .../Get-SPSessionStateService.md | 8 +- .../SharePointServer/Get-SPShellAdmin.md | 15 +- .../SharePointServer/Get-SPSite.md | 87 ++++--- .../Get-SPSiteAdministration.md | 71 +++--- .../SharePointServer/Get-SPSiteMaster.md | 16 +- .../Get-SPSiteSubscription.md | 15 +- .../Get-SPSiteSubscriptionConfig.md | 15 +- .../Get-SPSiteSubscriptionEdiscoveryHub.md | 22 +- ...SPSiteSubscriptionEdiscoverySearchScope.md | 22 +- .../Get-SPSiteSubscriptionFeaturePack.md | 23 +- .../Get-SPSiteSubscriptionIRMConfig.md | 15 +- .../Get-SPSiteSubscriptionMetadataConfig.md | 20 +- .../SharePointServer/Get-SPSiteURL.md | 23 +- .../Get-SPSiteUpgradeSessionInfo.md | 53 +++-- .../SharePointServer/Get-SPSolution.md | 15 +- .../Get-SPStateServiceApplication.md | 22 +- .../Get-SPStateServiceApplicationProxy.md | 22 +- .../Get-SPStateServiceDatabase.md | 28 ++- .../SharePointServer/Get-SPTaxonomySession.md | 14 +- .../SharePointServer/Get-SPThrottlingRule.md | 21 +- .../SharePointServer/Get-SPTimerJob.md | 28 ++- .../Get-SPTopologyServiceApplication.md | 15 +- .../Get-SPTopologyServiceApplicationProxy.md | 15 +- .../Get-SPTranslationThrottlingSetting.md | 24 +- .../Get-SPTrustedIdentityTokenIssuer.md | 15 +- .../Get-SPTrustedRootAuthority.md | 15 +- .../Get-SPTrustedSecurityTokenIssuer.md | 15 +- .../Get-SPTrustedServiceTokenIssuer.md | 15 +- .../SharePointServer/Get-SPUpgradeActions.md | 9 +- .../Get-SPUsageApplication.md | 21 +- .../SharePointServer/Get-SPUsageDefinition.md | 15 +- .../SharePointServer/Get-SPUsageService.md | 15 +- .../SharePointServer/Get-SPUser.md | 38 +-- .../SharePointServer/Get-SPUserLicense.md | 9 +- .../Get-SPUserLicenseMapping.md | 19 +- .../SharePointServer/Get-SPUserLicensing.md | 9 +- .../Get-SPUserSettingsProvider.md | 15 +- .../Get-SPUserSettingsProviderManager.md | 9 +- .../SharePointServer/Get-SPUserSolution.md | 21 +- .../Get-SPUserSolutionAllowList.md | 22 +- .../Get-SPVisioExternalData.md | 16 +- .../Get-SPVisioPerformance.md | 14 +- .../Get-SPVisioSafeDataProvider.md | 28 ++- .../Get-SPVisioServiceApplication.md | 16 +- .../Get-SPVisioServiceApplicationProxy.md | 16 +- .../SharePointServer/Get-SPWOPIBinding.md | 47 ++-- .../Get-SPWOPISuppressionSetting.md | 9 +- .../SharePointServer/Get-SPWOPIZone.md | 11 +- .../SharePointServer/Get-SPWeb.md | 53 +++-- .../SharePointServer/Get-SPWebApplication.md | 23 +- .../Get-SPWebApplicationAppDomain.md | 33 +-- ...t-SPWebApplicationHttpThrottlingMonitor.md | 15 +- .../SharePointServer/Get-SPWebPartPack.md | 27 ++- .../SharePointServer/Get-SPWebTemplate.md | 23 +- .../Get-SPWebTemplatesEnabledForSiteMaster.md | 10 +- .../SharePointServer/Get-SPWorkflowConfig.md | 21 +- .../Get-SPWorkflowServiceApplicationProxy.md | 16 +- ...ant-SPBusinessDataCatalogMetadataObject.md | 41 ++-- .../Grant-SPObjectSecurity.md | 35 +-- .../SharePointServer/Import-SPAppPackage.md | 47 ++-- ...ort-SPBusinessDataCatalogDotNetAssembly.md | 37 +-- .../Import-SPBusinessDataCatalogModel.md | 72 ++++-- .../Import-SPCacheClusterConfig.md | 18 +- .../SharePointServer/Import-SPCertificate.md | 8 +- ...erpriseSearchCustomExtractionDictionary.md | 34 +-- ...Import-SPEnterpriseSearchPopularQueries.md | 40 ++-- .../Import-SPEnterpriseSearchThesaurus.md | 32 ++- .../Import-SPEnterpriseSearchTopology.md | 28 ++- .../Import-SPInfoPathAdministrationFiles.md | 28 ++- ...mport-SPMetadataWebServicePartitionData.md | 50 ++-- .../Import-SPScaleOutDatabaseTenantData.md | 35 ++- ...port-SPServerScaleOutDatabaseTenantData.md | 30 +-- ...teSubscriptionBusinessDataCatalogConfig.md | 59 +++-- .../Import-SPSiteSubscriptionSettings.md | 40 ++-- .../SharePointServer/Import-SPWeb.md | 88 ++++--- .../Initialize-SPResourceSecurity.md | 9 +- .../Initialize-SPStateServiceDatabase.md | 20 +- .../SharePointServer/Install-SPApp.md | 29 ++- .../Install-SPApplicationContent.md | 11 +- .../Install-SPDataConnectionFile.md | 40 ++-- .../SharePointServer/Install-SPFeature.md | 59 +++-- .../Install-SPHelpCollection.md | 21 +- .../Install-SPInfoPathFormTemplate.md | 37 +-- .../SharePointServer/Install-SPService.md | 15 +- .../SharePointServer/Install-SPSolution.md | 103 ++++---- .../Install-SPUserSolution.md | 29 ++- .../SharePointServer/Install-SPWebPartPack.md | 58 +++-- ...tiveDirectoryEnterpriseResourcePoolSync.md | 16 +- ...nvoke-SPProjectActiveDirectoryGroupSync.md | 16 +- .../SharePointServer/Merge-SPLogFile.md | 107 +++++---- .../SharePointServer/Merge-SPUsageLog.md | 52 +++-- .../SharePointServer/Migrate-SPDatabase.md | 60 +++-- .../Migrate-SPProjectResourcePlans.md | 16 +- .../Mount-SPContentDatabase.md | 116 +++++---- .../Mount-SPStateServiceDatabase.md | 40 ++-- .../Move-SPAppManagementData.md | 43 ++-- .../Move-SPBlobStorageLocation.md | 49 ++-- .../SharePointServer/Move-SPCertificate.md | 2 +- .../SharePointServer/Move-SPDeletedSite.md | 47 ++-- .../Move-SPEnterpriseSearchLinksDatabases.md | 40 ++-- .../Move-SPProfileManagedMetadataProperty.md | 40 ++-- .../SharePointServer/Move-SPSite.md | 50 ++-- .../SharePointServer/Move-SPSocialComment.md | 40 ++-- .../SharePointServer/Move-SPUser.md | 37 +-- .../SharePointServer/New-SPAlternateURL.md | 47 ++-- .../New-SPAppManagementServiceApplication.md | 59 +++-- ...-SPAppManagementServiceApplicationProxy.md | 41 ++-- .../New-SPAuthenticationProvider.md | 55 +++-- ...ureAccessControlServiceApplicationProxy.md | 35 ++- .../New-SPBECWebServiceApplicationProxy.md | 32 ++- ...SPBusinessDataCatalogServiceApplication.md | 83 ++++--- ...inessDataCatalogServiceApplicationProxy.md | 46 ++-- .../SharePointServer/New-SPCache.md | 18 +- .../New-SPCentralAdministration.md | 44 ++-- .../SharePointServer/New-SPClaimProvider.md | 45 ++-- .../New-SPClaimTypeEncoding.md | 36 +-- .../New-SPClaimTypeMapping.md | 32 ++- .../SharePointServer/New-SPClaimsPrincipal.md | 80 ++++--- .../New-SPConfigurationDatabase.md | 107 ++++++--- .../SharePointServer/New-SPContentDatabase.md | 83 ++++--- .../New-SPContentDeploymentJob.md | 82 ++++--- .../New-SPContentDeploymentPath.md | 106 ++++++--- .../New-SPEnterpriseSearchAdminComponent.md | 33 ++- ...priseSearchAnalyticsProcessingComponent.md | 33 ++- ...iseSearchContentEnrichmentConfiguration.md | 8 +- ...erpriseSearchContentProcessingComponent.md | 34 ++- .../New-SPEnterpriseSearchCrawlComponent.md | 34 ++- ...ew-SPEnterpriseSearchCrawlContentSource.md | 84 +++---- ...-SPEnterpriseSearchCrawlCustomConnector.md | 40 ++-- .../New-SPEnterpriseSearchCrawlDatabase.md | 52 +++-- .../New-SPEnterpriseSearchCrawlExtension.md | 28 ++- .../New-SPEnterpriseSearchCrawlMapping.md | 33 ++- .../New-SPEnterpriseSearchCrawlRule.md | 111 +++++---- .../New-SPEnterpriseSearchFileFormat.md | 46 ++-- .../New-SPEnterpriseSearchIndexComponent.md | 53 +++-- ...PEnterpriseSearchLanguageResourcePhrase.md | 69 +++--- .../New-SPEnterpriseSearchLinksDatabase.md | 55 +++-- .../New-SPEnterpriseSearchMetadataCategory.md | 59 ++--- ...EnterpriseSearchMetadataCrawledProperty.md | 76 +++--- ...EnterpriseSearchMetadataManagedProperty.md | 130 ++++++----- .../New-SPEnterpriseSearchMetadataMapping.md | 48 ++-- .../New-SPEnterpriseSearchQueryAuthority.md | 39 ++-- .../New-SPEnterpriseSearchQueryDemoted.md | 35 +-- .../New-SPEnterpriseSearchQueryKeyword.md | 61 ++--- ...nterpriseSearchQueryProcessingComponent.md | 37 +-- .../New-SPEnterpriseSearchQueryScope.md | 65 +++--- .../New-SPEnterpriseSearchQueryScopeRule.md | 57 +++-- .../New-SPEnterpriseSearchRankingModel.md | 35 +-- .../New-SPEnterpriseSearchResultItemType.md | 109 ++++----- .../New-SPEnterpriseSearchResultSource.md | 119 +++++----- .../New-SPEnterpriseSearchSecurityTrimmer.md | 49 ++-- ...ew-SPEnterpriseSearchServiceApplication.md | 80 ++++--- ...EnterpriseSearchServiceApplicationProxy.md | 49 ++-- .../New-SPEnterpriseSearchSiteHitRule.md | 43 ++-- .../New-SPEnterpriseSearchTopology.md | 40 ++-- .../SharePointServer/New-SPLogFile.md | 11 +- .../SharePointServer/New-SPManagedAccount.md | 26 ++- .../SharePointServer/New-SPManagedPath.md | 43 ++-- ...SPMarketplaceWebServiceApplicationProxy.md | 37 +-- .../New-SPMetadataServiceApplication.md | 159 ++++++++----- .../New-SPMetadataServiceApplicationProxy.md | 77 +++--- .../New-SPODataConnectionSetting.md | 31 ++- ...ncipalManagementServiceApplicationProxy.md | 26 ++- ...PPowerPointConversionServiceApplication.md | 30 ++- ...rPointConversionServiceApplicationProxy.md | 35 +-- .../New-SPProfileServiceApplication.md | 146 +++++++----- .../New-SPProfileServiceApplicationProxy.md | 49 ++-- .../New-SPProjectServiceApplication.md | 34 +-- .../New-SPProjectServiceApplicationProxy.md | 26 ++- .../New-SPRequestManagementRuleCriteria.md | 40 ++-- .../New-SPSecureStoreApplication.md | 47 ++-- .../New-SPSecureStoreApplicationField.md | 29 ++- .../New-SPSecureStoreServiceApplication.md | 97 +++++--- ...ew-SPSecureStoreServiceApplicationProxy.md | 46 ++-- .../New-SPSecureStoreTargetApplication.md | 47 ++-- .../New-SPServiceApplicationPool.md | 31 ++- .../New-SPServiceApplicationProxyGroup.md | 25 +- .../SharePointServer/New-SPSite.md | 132 +++++++---- .../SharePointServer/New-SPSiteMaster.md | 45 ++-- .../New-SPSiteSubscription.md | 19 +- .../New-SPSiteSubscriptionFeaturePack.md | 19 +- .../New-SPStateServiceApplication.md | 22 +- .../New-SPStateServiceApplicationProxy.md | 29 ++- .../New-SPStateServiceDatabase.md | 40 ++-- ...PSubscriptionSettingsServiceApplication.md | 60 +++-- ...criptionSettingsServiceApplicationProxy.md | 30 ++- .../New-SPTranslationServiceApplication.md | 73 +++--- ...ew-SPTranslationServiceApplicationProxy.md | 49 ++-- .../New-SPTrustedIdentityTokenIssuer.md | 103 +++++--- .../New-SPTrustedRootAuthority.md | 37 +-- .../New-SPTrustedSecurityTokenIssuer.md | 55 +++-- .../New-SPTrustedServiceTokenIssuer.md | 43 ++-- .../New-SPUsageApplication.md | 61 +++-- .../SharePointServer/New-SPUsageLogFile.md | 11 +- .../SharePointServer/New-SPUser.md | 64 +++-- .../New-SPUserLicenseMapping.md | 79 ++++--- .../New-SPUserSettingsProvider.md | 29 ++- .../New-SPUserSolutionAllowList.md | 31 ++- .../New-SPVisioSafeDataProvider.md | 35 +-- .../New-SPVisioServiceApplication.md | 37 +-- .../New-SPVisioServiceApplicationProxy.md | 31 ++- .../SharePointServer/New-SPWOPIBinding.md | 63 +++-- .../New-SPWOPISuppressionSetting.md | 39 ++-- .../SharePointServer/New-SPWeb.md | 73 +++--- .../SharePointServer/New-SPWebApplication.md | 152 +++++++----- .../New-SPWebApplicationAppDomain.md | 31 +-- .../New-SPWebApplicationExtension.md | 111 ++++++--- .../New-SPWordConversionServiceApplication.md | 61 +++-- .../New-SPWorkflowServiceApplicationProxy.md | 26 ++- .../Pause-SPProjectWebInstance.md | 18 +- .../Publish-SPServiceApplication.md | 37 +-- ...eive-SPServiceApplicationConnectionInfo.md | 23 +- .../Register-SPAppPrincipal.md | 29 ++- .../Register-SPRemoteShareBlobStore.md | 34 ++- .../SharePointServer/Register-SPVssWriter.md | 6 +- .../Register-SPWorkflowService.md | 46 ++-- .../Remove-SPActivityFeedItems.md | 53 +++-- .../SharePointServer/Remove-SPAlternateURL.md | 28 ++- .../Remove-SPAppDeniedEndpoint.md | 25 +- .../Remove-SPAppPrincipalPermission.md | 43 ++-- .../Remove-SPApplicationCredentialKey.md | 22 +- .../Remove-SPBusinessDataCatalogModel.md | 25 +- .../Remove-SPCentralAdministration.md | 21 +- .../SharePointServer/Remove-SPCertificate.md | 2 +- ...Remove-SPCertificateNotificationContact.md | 2 +- .../Remove-SPClaimProvider.md | 17 +- .../Remove-SPClaimTypeMapping.md | 33 +-- .../Remove-SPConfigurationDatabase.md | 19 +- .../Remove-SPConfigurationObject.md | 22 +- .../Remove-SPContentDatabase.md | 31 ++- .../Remove-SPContentDeploymentJob.md | 25 +- .../Remove-SPContentDeploymentPath.md | 25 +- .../Remove-SPDatabaseFromAvailabilityGroup.md | 47 ++-- .../SharePointServer/Remove-SPDeletedSite.md | 37 +-- .../Remove-SPDiagnosticsPerformanceCounter.md | 55 +++-- ...emove-SPDistributedCacheServiceInstance.md | 10 +- .../Remove-SPEnterpriseSearchComponent.md | 39 ++-- ...iseSearchContentEnrichmentConfiguration.md | 17 +- ...ve-SPEnterpriseSearchCrawlContentSource.md | 31 ++- ...-SPEnterpriseSearchCrawlCustomConnector.md | 31 ++- .../Remove-SPEnterpriseSearchCrawlDatabase.md | 31 ++- ...Remove-SPEnterpriseSearchCrawlExtension.md | 31 ++- ...PEnterpriseSearchCrawlLogReadPermission.md | 43 ++-- .../Remove-SPEnterpriseSearchCrawlMapping.md | 31 ++- .../Remove-SPEnterpriseSearchCrawlRule.md | 31 ++- .../Remove-SPEnterpriseSearchFileFormat.md | 33 +-- ...PEnterpriseSearchLanguageResourcePhrase.md | 69 +++--- .../Remove-SPEnterpriseSearchLinksDatabase.md | 31 ++- ...move-SPEnterpriseSearchMetadataCategory.md | 33 +-- ...EnterpriseSearchMetadataManagedProperty.md | 47 ++-- ...emove-SPEnterpriseSearchMetadataMapping.md | 35 +-- ...Remove-SPEnterpriseSearchQueryAuthority.md | 35 +-- .../Remove-SPEnterpriseSearchQueryDemoted.md | 35 +-- .../Remove-SPEnterpriseSearchQueryKeyword.md | 31 ++- .../Remove-SPEnterpriseSearchQueryScope.md | 35 +-- ...Remove-SPEnterpriseSearchQueryScopeRule.md | 39 ++-- .../Remove-SPEnterpriseSearchRankingModel.md | 38 +-- ...Remove-SPEnterpriseSearchResultItemType.md | 42 ++-- .../Remove-SPEnterpriseSearchResultSource.md | 47 ++-- ...emove-SPEnterpriseSearchSecurityTrimmer.md | 31 ++- ...ve-SPEnterpriseSearchServiceApplication.md | 31 ++- ...EnterpriseSearchServiceApplicationProxy.md | 25 +- ...iseSearchServiceApplicationSiteSettings.md | 37 +-- .../Remove-SPEnterpriseSearchSiteHitRule.md | 31 ++- ...e-SPEnterpriseSearchTenantConfiguration.md | 29 ++- .../Remove-SPEnterpriseSearchTenantSchema.md | 39 ++-- .../Remove-SPEnterpriseSearchTopology.md | 34 +-- .../Remove-SPInfoPathUserAgent.md | 23 +- .../Remove-SPManagedAccount.md | 37 +-- .../SharePointServer/Remove-SPManagedPath.md | 40 ++-- .../Remove-SPODataConnectionSetting.md | 26 ++- ...eoplePickerDistributionListSearchDomain.md | 22 +- .../Remove-SPPeoplePickerSearchADDomain.md | 32 ++- ...PeoplePickerServiceAccountDirectoryPath.md | 22 +- .../Remove-SPPluggableSecurityTrimmer.md | 34 +-- .../Remove-SPProfileLeader.md | 37 +-- .../Remove-SPProfileSyncConnection.md | 67 ++++-- .../Remove-SPProjectWebInstanceData.md | 26 ++- .../Remove-SPRoutingMachineInfo.md | 17 +- .../Remove-SPRoutingMachinePool.md | 17 +- .../SharePointServer/Remove-SPRoutingRule.md | 17 +- .../Remove-SPScaleOutDatabase.md | 37 +-- .../Remove-SPSecureStoreApplication.md | 25 +- .../Remove-SPSecureStoreSystemAccount.md | 28 ++- .../Remove-SPServerScaleOutDatabase.md | 37 +-- .../Remove-SPServiceApplication.md | 31 ++- .../Remove-SPServiceApplicationPool.md | 25 +- .../Remove-SPServiceApplicationProxy.md | 30 ++- .../Remove-SPServiceApplicationProxyGroup.md | 25 +- ...ve-SPServiceApplicationProxyGroupMember.md | 29 ++- .../SharePointServer/Remove-SPShellAdmin.md | 31 ++- .../SharePointServer/Remove-SPSite.md | 50 ++-- .../SharePointServer/Remove-SPSiteMaster.md | 31 ++- .../Remove-SPSiteSubscription.md | 31 ++- ...teSubscriptionBusinessDataCatalogConfig.md | 25 +- .../Remove-SPSiteSubscriptionFeaturePack.md | 25 +- ...ove-SPSiteSubscriptionFeaturePackMember.md | 40 ++-- ...Remove-SPSiteSubscriptionMetadataConfig.md | 31 ++- .../Remove-SPSiteSubscriptionProfileConfig.md | 37 +-- .../Remove-SPSiteSubscriptionSettings.md | 53 +++-- .../SharePointServer/Remove-SPSiteURL.md | 25 +- .../Remove-SPSiteUpgradeSessionInfo.md | 25 +- .../Remove-SPSocialItemByDate.md | 55 +++-- .../SharePointServer/Remove-SPSolution.md | 37 +-- .../Remove-SPSolutionDeploymentLock.md | 25 +- .../Remove-SPStateServiceDatabase.md | 23 +- .../Remove-SPThrottlingRule.md | 17 +- .../Remove-SPTranslationServiceJobHistory.md | 55 +++-- .../Remove-SPTrustedIdentityTokenIssuer.md | 25 +- .../Remove-SPTrustedRootAuthority.md | 25 +- .../Remove-SPTrustedSecurityTokenIssuer.md | 25 +- .../Remove-SPTrustedServiceTokenIssuer.md | 25 +- .../Remove-SPUsageApplication.md | 37 +-- .../SharePointServer/Remove-SPUser.md | 38 +-- .../Remove-SPUserLicenseMapping.md | 25 +- .../Remove-SPUserSettingsProvider.md | 17 +- .../SharePointServer/Remove-SPUserSolution.md | 31 ++- .../Remove-SPVisioSafeDataProvider.md | 30 +-- .../SharePointServer/Remove-SPWOPIBinding.md | 75 +++--- .../Remove-SPWOPISuppressionSetting.md | 48 ++-- .../SharePointServer/Remove-SPWeb.md | 38 +-- .../Remove-SPWebApplication.md | 46 ++-- .../Remove-SPWebApplicationAppDomain.md | 27 ++- ...emove-SPWordConversionServiceJobHistory.md | 52 +++-- .../SharePointServer/Rename-SPCertificate.md | 2 +- .../SharePointServer/Rename-SPServer.md | 29 ++- .../SharePointServer/Renew-SPCertificate.md | 2 +- .../Repair-SPManagedAccountDeployment.md | 19 +- .../Repair-SPProjectWebInstance.md | 25 +- .../SharePointServer/Repair-SPSite.md | 40 ++-- .../Request-SPUpgradeEvaluationSite.md | 37 +-- .../Reset-SPProjectEventServiceSettings.md | 13 +- .../Reset-SPProjectPCSSettings.md | 17 +- .../Reset-SPProjectQueueSettings.md | 17 +- .../SharePointServer/Reset-SPSites.md | 26 ++- .../Restart-SPAppInstanceJob.md | 22 +- .../SharePointServer/Restore-SPDeletedSite.md | 37 +-- ...re-SPEnterpriseSearchServiceApplication.md | 91 +++++--- ...EnterpriseSearchServiceApplicationIndex.md | 67 +++--- .../SharePointServer/Restore-SPFarm.md | 97 +++++--- .../SharePointServer/Restore-SPSite.md | 81 ++++--- ...me-SPEnterpriseSearchServiceApplication.md | 23 +- .../Resume-SPProjectWebInstance.md | 17 +- .../Resume-SPStateServiceDatabase.md | 23 +- ...oke-SPBusinessDataCatalogMetadataObject.md | 43 ++-- .../Revoke-SPObjectSecurity.md | 37 +-- .../SharePointServer/Set-SPAlternateURL.md | 46 ++-- .../Set-SPAppAcquisitionConfiguration.md | 44 ++-- .../Set-SPAppAutoProvisionConnection.md | 56 +++-- .../Set-SPAppDisablingConfiguration.md | 29 +-- .../SharePointServer/Set-SPAppDomain.md | 25 +- .../Set-SPAppHostingQuotaConfiguration.md | 44 ++-- .../Set-SPAppManagementDeploymentId.md | 38 +-- .../Set-SPAppPrincipalPermission.md | 48 ++-- .../SharePointServer/Set-SPAppScaleProfile.md | 23 +- .../SharePointServer/Set-SPAppSiteDomain.md | 29 +-- .../Set-SPAppSiteSubscriptionName.md | 40 ++-- .../Set-SPAppStateUpdateInterval.md | 31 ++- .../Set-SPAppStoreConfiguration.md | 39 ++-- .../Set-SPAppStoreWebServiceConfiguration.md | 32 ++- .../Set-SPApplicationCredentialKey.md | 27 ++- .../Set-SPAuthenticationRealm.md | 31 ++- .../SharePointServer/Set-SPBingMapsBlock.md | 25 +- .../SharePointServer/Set-SPBingMapsKey.md | 25 +- ...serCustomerExperienceImprovementProgram.md | 49 ++-- ...usinessDataCatalogEntityNotificationWeb.md | 25 +- ...Set-SPBusinessDataCatalogMetadataObject.md | 55 +++-- ...SPBusinessDataCatalogServiceApplication.md | 79 ++++--- ...Set-SPBusinessDataCatalogThrottleConfig.md | 43 ++-- .../Set-SPCentralAdministration.md | 51 ++-- .../Set-SPCertificateSettings.md | 2 +- .../SharePointServer/Set-SPClaimProvider.md | 29 ++- .../SharePointServer/Set-SPContentDatabase.md | 52 +++-- .../Set-SPContentDeploymentJob.md | 85 ++++--- .../Set-SPContentDeploymentPath.md | 91 +++++--- .../Set-SPCustomLayoutsPage.md | 49 ++-- .../Set-SPDataConnectionFile.md | 58 +++-- .../Set-SPDefaultProfileConfig.md | 33 +-- .../Set-SPDesignerSettings.md | 81 ++++--- .../Set-SPDiagnosticConfig.md | 136 +++++++---- .../Set-SPDiagnosticsProvider.md | 46 ++-- .../Set-SPDistributedCacheClientSetting.md | 24 +- ...EnterpriseSearchAdministrationComponent.md | 51 ++-- ...iseSearchContentEnrichmentConfiguration.md | 42 ++-- ...et-SPEnterpriseSearchCrawlContentSource.md | 180 +++++++------- .../Set-SPEnterpriseSearchCrawlDatabase.md | 62 +++-- ...PEnterpriseSearchCrawlLogReadPermission.md | 43 ++-- .../Set-SPEnterpriseSearchCrawlRule.md | 109 +++++---- .../Set-SPEnterpriseSearchFileFormatState.md | 46 ++-- ...erpriseSearchLinguisticComponentsStatus.md | 64 ++--- .../Set-SPEnterpriseSearchLinksDatabase.md | 61 +++-- .../Set-SPEnterpriseSearchMetadataCategory.md | 56 +++-- ...EnterpriseSearchMetadataCrawledProperty.md | 34 +-- ...EnterpriseSearchMetadataManagedProperty.md | 125 +++++----- .../Set-SPEnterpriseSearchMetadataMapping.md | 55 +++-- ...SPEnterpriseSearchPrimaryHostController.md | 37 +-- .../Set-SPEnterpriseSearchQueryAuthority.md | 45 ++-- .../Set-SPEnterpriseSearchQueryKeyword.md | 66 +++--- .../Set-SPEnterpriseSearchQueryScope.md | 67 +++--- .../Set-SPEnterpriseSearchQueryScopeRule.md | 59 +++-- ...EnterpriseSearchQuerySpellingCorrection.md | 77 +++--- .../Set-SPEnterpriseSearchRankingModel.md | 43 ++-- .../Set-SPEnterpriseSearchResultItemType.md | 73 ++++-- .../Set-SPEnterpriseSearchResultSource.md | 131 ++++++----- .../Set-SPEnterpriseSearchService.md | 89 ++++--- ...et-SPEnterpriseSearchServiceApplication.md | 117 +++++----- ...EnterpriseSearchServiceApplicationProxy.md | 31 ++- .../Set-SPEnterpriseSearchServiceInstance.md | 35 +-- .../Set-SPEnterpriseSearchTopology.md | 33 +-- .../SharePointServer/Set-SPFarmConfig.md | 108 ++++++--- .../SharePointServer/Set-SPIRMSettings.md | 67 ++++-- .../Set-SPInfoPathFormTemplate.md | 31 ++- .../Set-SPInfoPathFormsService.md | 134 +++++++---- .../Set-SPInfoPathWebServiceProxy.md | 37 +-- .../Set-SPInternalAppStateUpdateInterval.md | 25 +- .../SharePointServer/Set-SPLogLevel.md | 44 ++-- .../SharePointServer/Set-SPMachineKey.md | 32 ++- .../SharePointServer/Set-SPManagedAccount.md | 84 ++++--- .../Set-SPMetadataServiceApplication.md | 154 +++++++----- .../Set-SPMetadataServiceApplicationProxy.md | 67 +++--- .../Set-SPMicrofeedOptions.md | 58 +++-- .../Set-SPMobileMessagingAccount.md | 45 ++-- .../Set-SPO365LinkSettings.md | 31 ++- .../Set-SPODataConnectionSetting.md | 43 +++- .../Set-SPODataConnectionSettingMetadata.md | 39 +++- .../Set-SPOfficeStoreAppsDefaultActivation.md | 39 ++-- .../SharePointServer/Set-SPPassPhrase.md | 37 +-- .../Set-SPPeoplePickerConfig.md | 46 +++- ...PPowerPointConversionServiceApplication.md | 50 ++-- .../Set-SPProfileServiceApplication.md | 121 ++++++---- .../Set-SPProfileServiceApplicationProxy.md | 55 +++-- ...Set-SPProfileServiceApplicationSecurity.md | 42 ++-- .../Set-SPProjectDatabaseQuota.md | 48 ++-- .../Set-SPProjectEventServiceSettings.md | 17 +- .../Set-SPProjectOdataConfiguration.md | 75 +++--- .../Set-SPProjectPCSSettings.md | 70 ++++-- .../Set-SPProjectPermissionMode.md | 26 ++- .../Set-SPProjectQueueSettings.md | 88 ++++--- .../Set-SPProjectServiceApplication.md | 23 +- .../SharePointServer/Set-SPProjectUserSync.md | 23 +- ...-SPProjectUserSyncDisabledSyncThreshold.md | 23 +- .../Set-SPProjectUserSyncFullSyncThreshold.md | 23 +- ...t-SPProjectUserSyncOffPeakSyncThreshold.md | 23 +- .../Set-SPRemoteShareBlobStore.md | 32 ++- .../Set-SPRequestManagementSettings.md | 33 ++- .../Set-SPRoutingMachineInfo.md | 46 ++-- .../Set-SPRoutingMachinePool.md | 21 +- .../SharePointServer/Set-SPRoutingRule.md | 41 ++-- .../Set-SPScaleOutDatabaseDataRange.md | 43 ++-- .../Set-SPScaleOutDatabaseDataSubRange.md | 67 ++++-- .../Set-SPSecureStoreApplication.md | 55 +++-- .../Set-SPSecureStoreDefaultProvider.md | 17 +- .../Set-SPSecureStoreServiceApplication.md | 85 ++++--- .../Set-SPSecurityTokenServiceConfig.md | 125 +++++----- .../SharePointServer/Set-SPServer.md | 36 +-- .../Set-SPServerScaleOutDatabaseDataRange.md | 51 ++-- ...et-SPServerScaleOutDatabaseDataSubRange.md | 78 ++++--- .../Set-SPServiceApplication.md | 43 ++-- .../Set-SPServiceApplicationEndpoint.md | 37 +-- .../Set-SPServiceApplicationPool.md | 31 ++- .../Set-SPServiceApplicationSecurity.md | 29 ++- .../Set-SPServiceHostConfig.md | 63 +++-- .../Set-SPSessionStateService.md | 31 ++- .../SharePointServer/Set-SPSite.md | 106 ++++++--- .../Set-SPSiteAdministration.md | 80 ++++--- .../Set-SPSiteSubscriptionConfig.md | 43 ++-- .../Set-SPSiteSubscriptionEdiscoveryHub.md | 31 ++- .../Set-SPSiteSubscriptionIRMConfig.md | 46 ++-- .../Set-SPSiteSubscriptionMetadataConfig.md | 49 ++-- .../Set-SPSiteSubscriptionProfileConfig.md | 68 +++--- .../SharePointServer/Set-SPSiteURL.md | 38 +-- .../Set-SPStateServiceApplication.md | 31 ++- .../Set-SPStateServiceApplicationProxy.md | 30 ++- .../Set-SPStateServiceDatabase.md | 44 ++-- ...PSubscriptionSettingsServiceApplication.md | 49 ++-- .../SharePointServer/Set-SPThrottlingRule.md | 35 +-- .../SharePointServer/Set-SPTimerJob.md | 30 ++- .../Set-SPTopologyServiceApplication.md | 31 ++- .../Set-SPTopologyServiceApplicationProxy.md | 31 ++- .../Set-SPTranslationServiceApplication.md | 197 ++++++++++------ ...et-SPTranslationServiceApplicationProxy.md | 40 ++-- .../Set-SPTranslationThrottlingSetting.md | 34 +-- .../Set-SPTrustedIdentityTokenIssuer.md | 88 ++++--- .../Set-SPTrustedRootAuthority.md | 37 +-- .../Set-SPTrustedSecurityTokenIssuer.md | 55 +++-- .../Set-SPTrustedServiceTokenIssuer.md | 46 ++-- .../Set-SPUsageApplication.md | 67 ++++-- .../SharePointServer/Set-SPUsageDefinition.md | 55 +++-- .../SharePointServer/Set-SPUsageService.md | 55 +++-- .../SharePointServer/Set-SPUser.md | 87 ++++--- .../Set-SPVisioExternalData.md | 21 +- .../Set-SPVisioPerformance.md | 50 ++-- .../Set-SPVisioSafeDataProvider.md | 37 +-- .../Set-SPVisioServiceApplication.md | 33 +-- .../SharePointServer/Set-SPWOPIBinding.md | 31 ++- .../SharePointServer/Set-SPWOPIZone.md | 25 +- .../SharePointServer/Set-SPWeb.md | 48 ++-- .../SharePointServer/Set-SPWebApplication.md | 131 +++++++---- ...t-SPWebApplicationHttpThrottlingMonitor.md | 63 +++-- .../Set-SPWordConversionServiceApplication.md | 144 ++++++++---- .../SharePointServer/Set-SPWorkflowConfig.md | 46 ++-- .../Split-SPScaleOutDatabase.md | 73 ++++-- .../Split-SPServerScaleOutDatabase.md | 84 ++++--- .../SharePointServer/Start-SPAdminJob.md | 19 +- .../SharePointServer/Start-SPAssignment.md | 19 +- .../SharePointServer/Start-SPCacheCluster.md | 14 +- .../Start-SPContentDeploymentJob.md | 47 ++-- .../Start-SPDiagnosticsSession.md | 30 +-- ...archQueryAndSiteSettingsServiceInstance.md | 25 +- ...Start-SPEnterpriseSearchServiceInstance.md | 24 +- .../Start-SPInfoPathFormTemplate.md | 24 +- .../SharePointServer/Start-SPService.md | 33 +-- .../Start-SPServiceInstance.md | 24 +- .../SharePointServer/Start-SPTimerJob.md | 23 +- .../SharePointServer/Stop-SPAssignment.md | 23 +- .../SharePointServer/Stop-SPCacheCluster.md | 14 +- .../Stop-SPContentTypeReplication.md | 10 +- .../Stop-SPDiagnosticsSession.md | 10 +- .../Stop-SPDistributedCacheServiceInstance.md | 15 +- ...archQueryAndSiteSettingsServiceInstance.md | 23 +- .../Stop-SPEnterpriseSearchServiceInstance.md | 26 ++- .../Stop-SPInfoPathFormTemplate.md | 28 ++- .../SharePointServer/Stop-SPService.md | 37 +-- .../Stop-SPServiceInstance.md | 23 +- .../Stop-SPTaxonomyReplication.md | 14 +- ...nd-SPEnterpriseSearchServiceApplication.md | 22 +- .../Suspend-SPStateServiceDatabase.md | 20 +- .../SharePointServer/Switch-SPBlobStorage.md | 28 ++- .../SharePointServer/Switch-SPCertificate.md | 2 +- .../Sync-SPProjectPermissions.md | 40 ++-- .../Test-SPContentDatabase.md | 60 +++-- .../Test-SPInfoPathFormTemplate.md | 14 +- .../Test-SPO365LinkSettings.md | 17 +- .../Test-SPProjectServiceApplication.md | 22 +- .../Test-SPProjectWebInstance.md | 22 +- .../Test-SPRemoteShareBlobStore.md | 24 +- .../SharePointServer/Test-SPSite.md | 29 ++- .../Uninstall-SPAppInstance.md | 26 ++- .../Uninstall-SPDataConnectionFile.md | 22 +- .../SharePointServer/Uninstall-SPFeature.md | 38 +-- .../Uninstall-SPHelpCollection.md | 23 +- .../Uninstall-SPInfoPathFormTemplate.md | 23 +- .../SharePointServer/Uninstall-SPSolution.md | 60 +++-- .../Uninstall-SPUserSolution.md | 29 ++- .../Uninstall-SPWebPartPack.md | 43 ++-- .../Unpublish-SPServiceApplication.md | 23 +- .../Unregister-SPRemoteShareBlobStore.md | 22 +- .../Unregister-SPVssWriter.md | 6 +- .../Update-SPAppCatalogConfiguration.md | 38 +-- .../SharePointServer/Update-SPAppInstance.md | 31 ++- .../Update-SPAzureBlobConfigLocatorEx1.md | 10 +- .../Update-SPDataRetrievalServiceConfig.md | 50 ++-- .../Update-SPDistributedCacheSize.md | 16 +- .../Update-SPFarmEncryptionKey.md | 23 +- .../Update-SPFlightsConfigFile.md | 18 +- .../Update-SPInfoPathAdminFileUrl.md | 34 ++- .../Update-SPInfoPathFormTemplate.md | 16 +- .../Update-SPInfoPathUserFileUrl.md | 53 +++-- .../SharePointServer/Update-SPMachineKey.md | 24 +- .../Update-SPProfilePhotoStore.md | 38 +-- .../SharePointServer/Update-SPProfileSync.md | 6 +- .../Update-SPRepopulateMicroblogFeedCache.md | 48 ++-- .../Update-SPRepopulateMicroblogLMTCache.md | 15 +- ...pdate-SPSecureStoreApplicationServerKey.md | 20 +- .../Update-SPSecureStoreCredentialMapping.md | 34 ++- ...ate-SPSecureStoreGroupCredentialMapping.md | 28 ++- .../Update-SPSecureStoreMasterKey.md | 22 +- .../SharePointServer/Update-SPSolution.md | 65 ++++-- .../SharePointServer/Update-SPUserSolution.md | 35 ++- .../SharePointServer/Update-SPWOPIProofKey.md | 15 +- ...grade-SPAppManagementServiceApplication.md | 37 +-- .../Upgrade-SPContentDatabase.md | 84 ++++--- ...de-SPEnterpriseSearchServiceApplication.md | 26 ++- ...iseSearchServiceApplicationSiteSettings.md | 23 +- .../SharePointServer/Upgrade-SPFarm.md | 33 ++- .../Upgrade-SPProfileServiceApplication.md | 24 +- .../Upgrade-SPSingleSignOnDatabase.md | 26 ++- .../SharePointServer/Upgrade-SPSite.md | 56 +++-- .../SharePointServer/Use-SPCacheCluster.md | 14 +- 1931 files changed, 41424 insertions(+), 25630 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md index 6f9a749f0..df80531bb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md @@ -56,7 +56,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -75,7 +74,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -94,7 +92,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -113,7 +110,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md index 1ea06080a..9acb9b84a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md @@ -44,7 +44,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md index edc245699..89411a50b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md @@ -62,7 +62,6 @@ Type: System.String Parameter Sets: Group Aliases: - Required: True Position: 0 Default value: None @@ -81,7 +80,6 @@ Type: System.Guid Parameter Sets: ObjectId Aliases: - Required: True Position: 0 Default value: None @@ -100,7 +98,6 @@ Type: System.String Parameter Sets: User Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md index c4714bfd1..fffc05002 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md @@ -49,7 +49,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -68,7 +67,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md index e513a37e7..5837a6eea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md @@ -96,7 +96,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -152,7 +151,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md index cb459c973..72fd17e92 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md @@ -52,7 +52,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -72,7 +71,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -92,7 +90,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md index 708aa7b16..b6bde2822 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md @@ -53,7 +53,6 @@ Parameter Sets: (All) Aliases: Accepted values: Public, Private - Required: True Position: Named Default value: None @@ -74,7 +73,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -112,7 +110,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md index f985f064f..7e9606312 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md @@ -59,7 +59,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -78,7 +77,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -97,7 +95,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md index 3ff358fb8..024732a14 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md @@ -37,7 +37,6 @@ Approve-SPOTenantServicePrincipalPermissionGrant -Resource "Microsoft Graph" -Sc Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mail.Read'. - ## PARAMETERS ### -Resource @@ -51,7 +50,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -70,7 +68,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md index a4dfef227..40662c91d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md @@ -111,7 +111,6 @@ Type: System.String Parameter Sets: AuthenticationUrl Aliases: - Required: True Position: Named Default value: None @@ -130,7 +129,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -149,7 +147,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -191,7 +188,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocatio Parameter Sets: AuthenticationLocation Aliases: - Required: False Position: Named Default value: None @@ -210,7 +206,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md index a64dd1399..70e9a76f5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md @@ -68,7 +68,6 @@ Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -87,7 +86,6 @@ Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -106,7 +104,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -125,7 +122,6 @@ Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -144,7 +140,6 @@ Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -163,7 +158,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -182,7 +176,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md index 5f9d9c325..01ac7d316 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md @@ -62,7 +62,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -81,7 +80,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -100,7 +98,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -119,7 +116,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -138,7 +134,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 2 Default value: None @@ -157,7 +152,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -176,7 +170,6 @@ Type: System.Int64 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -195,7 +188,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -214,7 +206,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -233,7 +224,6 @@ Type: System.String Parameter Sets: DocumentLibraryImport Aliases: - Required: True Position: Named Default value: None @@ -252,7 +242,6 @@ Type: System.String Parameter Sets: DocumentLibraryImport Aliases: - Required: False Position: Named Default value: None @@ -272,7 +261,6 @@ Parameter Sets: (All) Aliases: Accepted values: Production, ProductionChina, None, OnPremises - Required: False Position: Named Default value: None @@ -291,7 +279,6 @@ Type: System.String Parameter Sets: ListImport Aliases: - Required: True Position: Named Default value: None @@ -310,7 +297,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 3 Default value: None @@ -329,7 +315,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md index c15d38e81..19470a382 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md @@ -119,7 +119,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -138,7 +137,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -157,7 +155,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -176,7 +173,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md index d22842600..386632f90 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md @@ -106,7 +106,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md index f7de90e81..7ed296b2a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md @@ -10,7 +10,6 @@ ms.author: trgreen ms.reviewer: --- - # Export-SPOQueryLogs ## SYNOPSIS @@ -72,7 +71,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -91,7 +89,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -110,7 +107,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md index 4984dd1ab..be6e885dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md @@ -65,7 +65,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -84,7 +83,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -103,7 +101,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md index 125b810b9..7a2b04e46 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md @@ -51,7 +51,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -70,7 +69,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md index 4004370a5..9b1446ff2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md @@ -48,7 +48,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md index 47bdc81ae..257b0ed70 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md @@ -69,7 +69,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -88,7 +87,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -107,7 +105,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md index 5eeaf5c6b..d5ef38ccd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md @@ -73,7 +73,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 2 Default value: None @@ -92,7 +91,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md index 6fa16a6c6..6ad826c0e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md @@ -28,8 +28,7 @@ This cmdlet is used to retrieve and return SharePoint Embedded applications from In addition to providing details about the application name, this cmdlet also returns essential information about guest applications and their associated permissions on the owning application. The cmdlet displays data related to the sharing capabilities, including the `OverrideTenantSharingCapability` status. Furthermore, the cmdlet lists all host URLs allowed to use the SharePoint Embedded application's declarative agent experience. -You must be a SharePoint Embedded Administrator to run the cmdlet. - +You must be a SharePoint Embedded Administrator to run the cmdlet. ## EXAMPLES @@ -47,7 +46,7 @@ Example 1 returns all SharePoint Embedded applications registered in the specifi Get-SPOApplication -OwningApplicationId ``` -Example 2 provides details about the application corresponding to the owning application Id in the specified tenant. It returns applications, which includes the list of guest application IDs with permissions to the owning application, as well as the SharingCapability settings, the `OverrideTenantSharingCapability` status and the list of all Copilot embedded chat host URLs. +Example 2 provides details about the application corresponding to the owning application Id in the specified tenant. It returns applications, which includes the list of guest application IDs with permissions to the owning application, as well as the SharingCapability settings, the `OverrideTenantSharingCapability` status and the list of all Copilot embedded chat host URLs. ### Example 3 @@ -100,7 +99,7 @@ The following details are returned: - OverrideTenantSharingCapability - CopilotEmbeddedChatHosts - + ```yaml Type: System.Guid Parameter Sets: (All) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md index cf20c5f6f..222a9ccf8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md @@ -32,7 +32,6 @@ The `Get-SPOBuiltInSiteTemplateSettings` cmdlet displays the current state of Mi > - The minimum SharePoint PowerShell version required is 16.0.21610.12000. > - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - ## EXAMPLES ### Check which Microsoft templates are hidden @@ -45,7 +44,6 @@ Get-SPOBuiltInSiteTemplateSettings >[!NOTE] > If a site template has never been hidden, it will not show up in the list. If a site template has been hidden, then changed back to displayed (i.e. currently set to True), then it will show up in the list. - ## PARAMETERS ### -Identity diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md index 4b29cdbed..74217ec53 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md @@ -47,10 +47,8 @@ The `Get-SPOContainer` cmdlet retrieves details of an individual container, eith You must be a SharePoint Embedded Administrator to run this cmdlet. - For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - > [!NOTE] > Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet. > The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`. @@ -73,7 +71,6 @@ Get-SPOContainer -OwningApplicationId 423poi45 | ft ``` Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`. - ### Example 3 ```powershell @@ -121,7 +118,6 @@ Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45. - ## PARAMETERS ### -ArchiveStatus @@ -136,14 +132,12 @@ The ArchiveStatus parameter is used to display containers in various stages of a - Reactivating – Displays containers in the "Reactivating" state. - NotArchived – Displays active containers - ```yaml Type: Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusFilterProperties Parameter Sets: Archive Aliases: Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived - Required: True Position: 1 Default value: None @@ -162,7 +156,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: Identity Aliases: - Required: True Position: Named Default value: None @@ -181,7 +174,6 @@ Type: System.Guid Parameter Sets: OwningApplicationId, Sort, Archive Aliases: - Required: True Position: 0 Default value: None @@ -200,7 +192,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: OwningApplicationId, Sort, Archive Aliases: - Required: False Position: 1 Default value: None @@ -208,7 +199,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -PagingToken > Applicable: SharePoint Online @@ -220,7 +210,6 @@ Type: System.String Parameter Sets: OwningApplicationId, Sort, Archive Aliases: - Required: False Position: 2 Default value: None @@ -245,19 +234,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Microsoft.Online.SharePoint.TenantManagement.SortOrder -Parameter Sets: Archive -Aliases: -Accepted values: Ascending, Descending - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). @@ -287,4 +263,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Restore-SPODeletedContainer](./Restore-SPODeletedContainer.md) - diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md index 93206905a..d22268f8e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md @@ -70,7 +70,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md index 0202f2f3c..e4d791e61 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md @@ -51,7 +51,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md index a2bab9afa..1fea82427 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md @@ -81,7 +81,6 @@ Parameter Sets: (All) Aliases: Accepted values: View, Download - Required: False Position: Named Default value: View @@ -137,7 +136,6 @@ Parameter Sets: (All) Aliases: Accepted values: CopilotAgentsOnSites, TopSites, SiteDistribution - Required: False Position: Named Default value: CopilotAgentsOnSites @@ -156,7 +154,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md index 365486f02..c20c49b75 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md @@ -62,7 +62,6 @@ Parameter Sets: (All) Aliases: Accepted values: MoveIn, MoveOut - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md index b3f38723e..25ba645bf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md @@ -68,7 +68,6 @@ Type: System.Boolean Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md index 9020ecc54..f7e5b8146 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md @@ -51,7 +51,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md index 06672a804..a3d73f834 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md @@ -42,7 +42,6 @@ Get-SPODeletedContainer This example returns a list of the `ContainerId`, `ContainerName`, and `CreatedDate` of all deleted Containers in the Recycle Bin. - ## PARAMETERS ### CommonParameters diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md index ae326c468..13d1ead7b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md @@ -71,7 +71,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: False Position: 1 Default value: None @@ -90,7 +89,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: ParameterSetPersonalSitesOnly Aliases: - Required: True Position: Named Default value: None @@ -109,7 +107,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: ParameterSetAllSites Aliases: - Required: False Position: Named Default value: None @@ -131,7 +128,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md index be89071f4..e46f22bea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md @@ -90,7 +90,6 @@ Parameter Sets: (All) Aliases: Accepted values: View, Download - Required: False Position: Named Default value: None @@ -109,7 +108,6 @@ Type: Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md index 86f278be4..97fc6d976 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md @@ -69,7 +69,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 4 Default value: None @@ -90,7 +89,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: 3 Default value: None @@ -109,7 +107,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: 2 Default value: None @@ -128,7 +125,6 @@ Type: System.Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -149,7 +145,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 6 Default value: None @@ -168,7 +163,6 @@ Type: Microsoft.Online.SharePoint.TenantManagement.SortOrder Parameter Sets: (All) Aliases: - Required: False Position: 5 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md index 76a587f28..4d3e7e9e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md @@ -59,7 +59,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md index c07e0565a..9d1478b4f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md @@ -75,7 +75,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: - Required: False Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md index 07dc9b361..867743620 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md @@ -16,7 +16,6 @@ ms.reviewer: Extracts and displays the malware-related information of an infected file stored in SharePoint. - ## SYNTAX ``` @@ -52,7 +51,6 @@ Type: System.Uri Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md index 997d30de6..f120ad1ef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md @@ -82,7 +82,6 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOMalwareFile Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md index 34eebaa50..f0240277f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md @@ -95,7 +95,6 @@ Type: System.String Parameter Sets: AzureLocationsInline Aliases: - Required: True Position: Named Default value: None @@ -114,7 +113,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -133,7 +131,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -152,7 +149,6 @@ Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -171,7 +167,6 @@ Type: System.Guid[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -190,7 +185,6 @@ Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsImplicit Aliases: - Required: True Position: Named Default value: None @@ -209,7 +203,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -228,7 +221,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md index cdb900685..db3ae92fa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md @@ -55,7 +55,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -74,7 +73,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -93,7 +91,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -112,7 +109,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md index 6f15a3ab2..c2938ce9b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md @@ -61,7 +61,6 @@ Get-SPOPersonalSitePageCopyProgress -DestinationSite 'https://contoso.sharepoint Example 1 shows how a SharePoint Administrator can check the status of a copy operation using a work item ID. - ## PARAMETERS ### -DestinationSite @@ -75,7 +74,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -94,7 +92,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index 5c649f8cc..5feb73ad8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -123,7 +123,6 @@ Get-SPOSite -Filter { Url -like "contoso.sharepoint.com/sites/18" } This example uses server side filtering to return sites matching 18. - ### EXAMPLE 8 ```powershell @@ -140,7 +139,6 @@ Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true} This example uses client-side filtering to return a list of sites connected to a Microsoft Teams Private or Shared channel. - ### EXAMPLE 10 ```powershell @@ -148,7 +146,6 @@ Get-SPOSite -Limit ALL -GroupIdDefined $true ``` This example uses server-side filtering to return all sites that have an associated Microsoft 365 Group. - ### EXAMPLE 11 ```powershell @@ -157,7 +154,6 @@ Get-SPOSite -Filter "Owner -like '$($userUPN)'" ``` This example retrieves all sites filtering by the specified owner using a variable. - ## PARAMETERS ### -ArchiveStatus @@ -172,7 +168,6 @@ Parameter Sets: ParamSet2 Aliases: Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived - Required: False Position: Named Default value: None @@ -208,7 +203,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1, ParamSet2 Aliases: - Required: False Position: Named Default value: None @@ -230,7 +224,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet3 Aliases: - Required: False Position: Named Default value: None @@ -253,7 +246,6 @@ Type: System.String Parameter Sets: ParamSet2 Aliases: - Required: False Position: Named Default value: None @@ -274,7 +266,6 @@ Type: System.Boolean Parameter Sets: ParamSet2 Aliases: - Required: False Position: Named Default value: None @@ -293,7 +284,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: ParamSet1, ParamSet3 Aliases: - Required: False Position: 0 Default value: None @@ -314,7 +304,6 @@ Type: System.Boolean Parameter Sets: ParamSet2 Aliases: - Required: False Position: Named Default value: None @@ -333,7 +322,6 @@ Type: System.String Parameter Sets: ParamSet1, ParamSet2 Aliases: - Required: False Position: Named Default value: None @@ -352,7 +340,6 @@ Type: System.String Parameter Sets: ParamSet2 Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md index feaf0751e..9b5fa5671 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md @@ -163,7 +163,6 @@ Type: System.String Parameter Sets: SourceSiteUrl Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md index 89b35ccbc..3014543ab 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md @@ -53,7 +53,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -72,7 +71,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -91,7 +89,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md index 1a9874c78..d9f55ef0e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md @@ -45,7 +45,6 @@ Get-SPOSitePages -Site 'https://contoso.sharepoint.com/sites/testsite' Example 1 demonstrates how a SharePoint Administrator can retrieve all the SharePoint pages under the `testsite`. - ## PARAMETERS ### -Site @@ -59,7 +58,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md index 237893ca9..412440619 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md @@ -74,7 +74,6 @@ For technical information, type: "get-help Get-SPOStructuralNavigationCacheSiteS For online help, type: "get-help Get-SPOStructuralNavigationCacheSiteState -online" - ## RELATED LINKS [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md index 4aebfbc65..d349cb0d9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md @@ -50,7 +50,6 @@ Parameter Sets: (All) Aliases: Accepted values: Public, Private - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md index fcdb01dca..afdc580c2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md @@ -50,7 +50,6 @@ Parameter Sets: (All) Aliases: Accepted values: Public, Private - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md index cc179f7b8..71460d654 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md @@ -58,7 +58,6 @@ Parameter Sets: (All) Aliases: Accepted values: Public, Private - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md index ae9ff55bf..7473b2e61 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md @@ -108,7 +108,6 @@ Type: System.Guid Parameter Sets: CorrelationId Aliases: - Required: True Position: Named Default value: None @@ -127,7 +126,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: 1 Default value: None @@ -146,7 +144,6 @@ Type: System.UInt32 Parameter Sets: (All) Aliases: - Required: False Position: 2 Default value: None @@ -165,7 +162,6 @@ Type: System.Int32 Parameter Sets: Source Aliases: - Required: True Position: Named Default value: None @@ -184,7 +180,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: 0 Default value: None @@ -203,7 +198,6 @@ Type: System.String Parameter Sets: User Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md index 91a1a4a5e..e9431e72a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md @@ -84,7 +84,6 @@ Type: System.String Parameter Sets: ByGroup Aliases: - Required: False Position: Named Default value: None @@ -103,7 +102,6 @@ Type: System.String Parameter Sets: All, ByGroup Aliases: - Required: False Position: Named Default value: None @@ -122,7 +120,6 @@ Type: System.String Parameter Sets: ByLogin Aliases: - Required: False Position: Named Default value: None @@ -141,7 +138,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md index b498c6cac..6792c3638 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md @@ -113,7 +113,6 @@ Type: System.UInt32 Parameter Sets: MoveReport Aliases: - Required: False Position: Named Default value: None @@ -149,7 +148,6 @@ Type: System.DateTime Parameter Sets: MoveReport Aliases: - Required: False Position: Named Default value: None @@ -168,7 +166,6 @@ Type: System.DateTime Parameter Sets: MoveReport Aliases: - Required: False Position: Named Default value: None @@ -188,7 +185,6 @@ Parameter Sets: MoveReport Aliases: Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All - Required: False Position: Named Default value: None @@ -207,7 +203,6 @@ Type: System.Guid Parameter Sets: OdbMoveId Aliases: - Required: True Position: Named Default value: None @@ -226,7 +221,6 @@ Type: String Parameter Sets: UserPrincipalName Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md index 1883202c9..7d68aa118 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md @@ -49,7 +49,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md index 71bf41ce0..1911863db 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md @@ -62,7 +62,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -81,7 +80,6 @@ Type: System.UInt32 Parameter Sets: (All) Aliases: - Required: False Position: 0 Default value: None @@ -100,7 +98,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -119,7 +116,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md index 170634793..505a4f654 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md @@ -54,7 +54,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite - Required: True Position: 0 Default value: None @@ -73,7 +72,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -93,7 +91,6 @@ Parameter Sets: (All) Aliases: Accepted values: Join - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md index 151f8d488..1c6095339 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md @@ -83,7 +83,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -102,7 +101,6 @@ Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -121,7 +119,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -155,7 +152,6 @@ Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -174,7 +170,6 @@ Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: - Required: True Position: Named Default value: None @@ -193,7 +188,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md index 497ea966d..8a2336d95 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md @@ -91,7 +91,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -110,7 +109,6 @@ Type: Switch Parameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -133,7 +131,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -152,7 +149,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -175,7 +171,6 @@ Type: String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -199,7 +194,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md index 5fcb27b31..d34859a48 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md @@ -67,7 +67,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -86,7 +85,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -105,7 +103,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -124,7 +121,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -145,7 +141,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md index e25b131f2..e026106e5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md @@ -24,14 +24,12 @@ New-SPOContainerType [-ContainerTypeName] -OwningApplicationId [-IsGovernableByAdmin ] [-WhatIf] [-Confirm] [] ``` - ## DESCRIPTION This cmdlet creates a new standard or trial container type. A standard container type, by definition, has a billing profile associated with it and can be either regular billed or direct to consumer billed. A trial container type does not have a billing profile. In case of regular billing, the next step after creation is the addition of a billing profile using the [Add-SPOContainerTypeBilling](./Add-SPOContainerTypeBilling.md) cmdlet. With the use of `-IsPassThroughBilling`, you can create a direct to customer billed container type. There is no need to attach a billing profile in case this case. `–TrialContainerType` when used creates a trial container type that has a validity of 30 days. You must be a SharePoint Embedded Administrator to run this cmdlet. - ## EXAMPLES ### Example 1 @@ -66,7 +64,6 @@ New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4 In Example 4, the cmdlet creates a standard container type, ContosoLegal that has opted out of management through Microsoft-enabled administrator platforms. - ## PARAMETERS ### -ApplicationRedirectUrl @@ -80,7 +77,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -99,7 +95,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -118,7 +113,6 @@ Type: System.Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -137,7 +131,6 @@ Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -156,7 +149,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -175,7 +167,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -217,8 +208,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). - - ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md index ee50f5127..e49922e8b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md @@ -65,7 +65,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -84,7 +83,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -103,7 +101,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -122,7 +119,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -141,7 +137,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -160,7 +155,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -179,7 +173,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -198,7 +191,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 3 Default value: None @@ -217,7 +209,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 4 Default value: None @@ -236,7 +227,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 2 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md index 28dbdeaca..d1ce1b901 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md @@ -49,7 +49,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -68,7 +67,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -88,7 +86,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md index 8fa4413d5..8f7e61412 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md @@ -49,7 +49,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -68,7 +67,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -87,7 +85,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -107,7 +104,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md index 319ae2ad8..ecc312001 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md @@ -72,7 +72,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -106,7 +105,6 @@ Type: System.UInt32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -125,7 +123,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -144,7 +141,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -163,7 +159,6 @@ Type: System.Double Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -182,7 +177,6 @@ Type: System.Int64 Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -201,7 +195,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -220,7 +213,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -239,7 +231,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -258,7 +249,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md index ad2a441b4..69583c0ef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md @@ -62,7 +62,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -84,7 +83,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -103,7 +101,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md index 8b50b1dae..af5052693 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md @@ -54,7 +54,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -73,7 +72,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md index 45ff35539..15573e932 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md @@ -59,7 +59,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md index a5f8ed97b..8f920510d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md @@ -67,7 +67,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md index 7fc1dafa1..18e9279cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md @@ -51,7 +51,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md index c0a1d0788..edf07b8aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md @@ -41,7 +41,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md index 4b919d72c..415fd7240 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md @@ -30,9 +30,6 @@ The `Remove-SPODeletedContainer` cmdlet permanently removes a deleted File Stora > [!IMPORTANT] > We do not generally recommend that you permanently delete Containers. - - - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -45,8 +42,6 @@ Remove-SPODeletedContainer -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade This example removes a deleted Container with the `ContainerId` `b66f5b2e-4cbd-4754-9ad3-8291c2c81ade` from the Recycle Bin and deletes it permanently. - - ## PARAMETERS ### -Force @@ -75,7 +70,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md index abbf6ced7..f9218b67a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/sitetoremove @@ -55,7 +55,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -74,7 +73,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -93,7 +91,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -113,7 +110,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md index dd20edf6f..eee6d0272 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $user = Get-SPOExternalUser -Filter someone@example.com diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md index ed7cba40b..4a9faad24 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md @@ -105,7 +105,6 @@ Type: System.String Parameter Sets: User Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md index ad85a7fb6..08d6ff1d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md @@ -54,7 +54,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md index 7d5024379..1cba45499 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md @@ -50,7 +50,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -69,7 +68,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -88,7 +86,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -107,7 +104,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md index 02a678b88..3aa4eec1e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md @@ -48,7 +48,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md index 62bd788e2..20c833ba2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md @@ -56,7 +56,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -75,7 +74,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -95,7 +93,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md index 4f47675e3..8d9ceccf4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md @@ -57,7 +57,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -77,7 +76,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md index 399de75ac..984673ba6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md @@ -56,7 +56,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -75,7 +74,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -94,7 +92,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -114,7 +111,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md index ea91a2fab..60f5208c5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Identity GroupToRemove @@ -53,7 +53,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -72,7 +71,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md index a5969085f..50ee56170 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md @@ -67,7 +67,6 @@ Parameter Sets: (All) Aliases: Accepted values: Public, Private - Required: True Position: Named Default value: None @@ -92,7 +91,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -111,7 +109,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -131,7 +128,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md index 3d9d60a5b..fe0fbe4e0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md @@ -34,7 +34,7 @@ The `Remove-SPOTenantSyncClientRestriction` cmdlet does not have any parameters. ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPOTenantSyncClientRestriction diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md index 5dace112d..04f552c2c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" @@ -51,7 +51,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -70,7 +69,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -89,7 +87,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md index 7f0933ca2..a038e940e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md @@ -21,7 +21,6 @@ Do not use. Remove-SPOUserInfo -LoginName -Site [-RedactName ] [] ``` - ## DESCRIPTION Do not use. @@ -41,7 +40,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -75,7 +73,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md index 427a93bb3..e5662870f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md @@ -53,7 +53,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md index f9173b043..cbe51e054 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md @@ -67,7 +67,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -95,7 +94,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -114,7 +112,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -133,7 +130,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -153,7 +149,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md index 016ad9c7e..20ee0adc0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md @@ -66,7 +66,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -87,7 +86,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md index 195ccc402..c8a3b7cc4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md @@ -65,7 +65,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -84,7 +83,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -103,7 +101,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -122,7 +119,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -142,7 +138,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md index 18046ecb1..49e864305 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md @@ -26,8 +26,6 @@ Restore-SPODeletedContainer [-Identity] [ Applicable: SharePoint Online @@ -53,7 +48,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md index d7fd241cd..48f541889 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md @@ -51,7 +51,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -70,7 +69,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md index 8faa56dcc..b1464af6d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md @@ -53,7 +53,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite - Required: True Position: 0 Default value: None @@ -72,7 +71,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md index b9e8ac87c..58fe1975d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md @@ -75,7 +75,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -94,7 +93,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -114,7 +112,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md index e6a79a3ff..6ed4d469d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md @@ -132,7 +132,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -SharingCapability Determines what level of sharing is available for the SharePoint Embedded Application. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md index 36eda3354..829792995 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md @@ -40,7 +40,6 @@ You must be a SharePoint Administrator to run this cmdlet. For permissions and t Set-SPOApplicationPermission -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 -ApplicationId 12345678-1234-1234-abcd-abcdefghijkl -PermissionAppOnly Read, Write ``` - Example 1 gives the guest application with ID `12345678-1234-1234-abcd-abcdefghijkl` app-only Read, Write permissions to access the owning application Microsoft Loop of ID `a187e399-0c36-4b98-8f04-1edc167a0996`. ### Example 2 @@ -71,7 +70,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -90,7 +88,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -109,7 +106,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -128,7 +124,6 @@ Type: System.String[] Parameter Sets: (All) Aliases: - Required: False Position: 3 Default value: None @@ -136,7 +131,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md index 54762582d..845576b79 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md @@ -58,16 +58,12 @@ All site templates are displayed by default. You can hide all templates by specifying an empty ID of "00000000-0000-0000-0000-000000000000". Settings specified for a specific template will take precedence over the "all templates" setting. You can hide all templates and then selectively make specific templates visible. [Learn more about SharePoint site templates](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398). - - >[!NOTE] > - All site templates are displayed by default. [Learn more](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398) about SharePoint site templates > - You must have SharePoint admin credentials (or higher) to use SharePoint PowerShell. > - The minimum SharePoint PowerShell version required is 16.0.21610.12000. > - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - - ## EXAMPLES ### Example 1: Hide a template @@ -94,8 +90,6 @@ This example hides all built-in templates from the site template gallery. Set-SPOBuiltInSiteTemplateSettings -Identity "00000000-0000-0000-0000-000000000000" -IsHidden $true ``` - - ## PARAMETERS ### -Identity diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md index 74c4383cf..cd8665d61 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md @@ -57,7 +57,6 @@ For any parameters that are passed in, the `Set-SPOContainer` cmdlet sets or upd You must be a SharePoint Embedded Administrator to run the cmdlet. - For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the online documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -125,7 +124,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -BlockDownloadPolicy > Applicable: SharePoint Embedded diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md index 75e52cb92..5b2175ea8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md @@ -52,7 +52,6 @@ While you only need to be a SharePoint Embedded Administrator to set the basic i For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - ## EXAMPLES ### Example 1 @@ -63,7 +62,6 @@ Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f -Owni Example 1 sets the container type name as 'Red Container Type' - ### Example 2 ```powershell @@ -79,7 +77,6 @@ Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -Owni ``` In Example 3, the trial container type name is updated as 'Blue Container Type' - ## PARAMETERS ### -ApplicationRedirectUrl diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md index 82e42908c..374388d5a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md @@ -257,7 +257,6 @@ Sets a container type-specific list of security groups who are allowed to share Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to authenticated guests, set this allow list to a null array. - ```yaml Type: System.Guid[] Parameter Sets: (All) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md index b18bd375c..e85d62fde 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md @@ -47,7 +47,6 @@ Type: System.Boolean Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md index 4bee3c2b3..898d3479e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md @@ -49,7 +49,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -68,7 +67,6 @@ Parameter Sets: (All) Aliases: Accepted values: None, Source, Target - Required: True Position: 1 Default value: None @@ -86,7 +84,6 @@ Parameter Sets: (All) Aliases: Accepted values: None, MnA - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md index c36905c1d..6aa97538f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md @@ -41,7 +41,6 @@ PS C:\> Set-SPODisableSpacesActivation -Disable:$true -Identity https://contoso. This example disables the SharePoint Spaces activation for a site. - ## PARAMETERS ### -Disable diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md index 8c81f48e5..630f3f957 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md @@ -57,7 +57,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -76,7 +75,6 @@ Type: System.Int64 Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md index a6a547413..961732712 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md @@ -56,7 +56,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -105,7 +104,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite - Required: True Position: 0 Default value: None @@ -124,7 +122,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -143,7 +140,6 @@ Type: System.Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -162,7 +158,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -181,7 +176,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md index e33422223..e0fe5212f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md @@ -163,7 +163,6 @@ Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md index f36bf3941..f7b46ea82 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md @@ -50,7 +50,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md index 71e2a912d..f6950c6d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md @@ -150,7 +150,6 @@ PARAMVALUE: All | SharePoint | OneDrive | Team | Communication - Team - Only SharePoint team sites (group-connected and classic) - Communication - Only SharePoint communication sites - ```yaml Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationSiteType Parameter Sets: (All) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md index b17331d9d..503ee868d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md @@ -97,7 +97,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Add-SPOServicePrioritizationAppRegistration](./Add-SPOServicePrioritizationAppRegistration.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md index c64338d21..bea3356a3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md @@ -417,7 +417,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -AllowSelfServiceUpgrade > Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md index 293d68005..8a68100e9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md @@ -60,7 +60,6 @@ Parameter Sets: (All) Aliases: Accepted values: Archived, Active - Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md index dfc903ca9..9a9215f4d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md @@ -60,7 +60,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -83,7 +82,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 5 Default value: None @@ -102,7 +100,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 4 Default value: None @@ -121,7 +118,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -140,7 +136,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: 3 Default value: None @@ -159,7 +154,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: 6 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md index 6189a223a..3cc650373 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md @@ -98,7 +98,6 @@ For technical information, type: "get-help Set-SPOStructuralNavigationCacheSiteS For online help, type: "get-help Set-SPOStructuralNavigationCacheSiteState -online" - ## RELATED LINKS [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md index b156173f6..3fb8a3821 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md @@ -606,7 +606,6 @@ Set-SPOTenant -EnableVersionExpirationSetting $true The `EnableVersionExpirationSetting` parameter is no longer active, this feature is now automatically enabled for each tenant. Setting `EnableVersionExpirationSetting` to false would not disable the feature. [Learn more about Version History Settings](/sharepoint/document-library-version-history-limits) - ### EXAMPLE 17 ```powershell diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md index 43d3e5626..e7f4b7777 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md @@ -148,7 +148,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: - Required: False Position: Named Default value: None @@ -165,7 +164,6 @@ Type: System.Boolean Parameter Sets: ReportProblemDialogFeature Aliases: - Required: True Position: Named Default value: None @@ -184,7 +182,6 @@ Type: System.String Parameter Sets: Blocking Aliases: - Required: False Position: Named Default value: None @@ -203,7 +200,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: - Required: False Position: Named Default value: None @@ -225,7 +221,6 @@ Type: System.String Parameter Sets: FileExclusion Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md index 3077ea5f9..773dfbf33 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md @@ -69,7 +69,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -88,7 +87,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md index d06982a82..588ba8074 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md @@ -66,7 +66,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -85,7 +84,6 @@ Type: System.Int32 Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md index e2c380934..da897ef55 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md @@ -59,7 +59,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -78,7 +77,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -97,7 +95,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md index 3f01bb9cf..57cd96a2e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md @@ -119,7 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -PreferredMoveBeginDate > Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index b80aca5e1..23f116bba 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -59,7 +59,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md index 5736b8d5a..e5eecc53a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md @@ -78,7 +78,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -97,7 +96,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -116,7 +114,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -135,7 +132,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -184,7 +180,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -203,7 +198,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -222,7 +216,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -240,7 +233,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -259,7 +251,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md index a8ac5ea14..6500f21cc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md @@ -59,7 +59,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -78,7 +77,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -96,7 +94,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md index 1f0475d2f..0a7856433 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md @@ -67,7 +67,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 2 Default value: None @@ -86,7 +85,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: 5 Default value: None @@ -105,7 +103,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: 3 Default value: None @@ -124,7 +121,6 @@ Type: System.DateTime Parameter Sets: (All) Aliases: - Required: False Position: 4 Default value: None @@ -158,7 +154,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None @@ -177,7 +172,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: 7 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md index 7a4ff8443..cf144eca1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md @@ -55,7 +55,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -74,7 +73,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md index 190b899d8..d4545c081 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md @@ -57,7 +57,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md index 421931d72..cce57a685 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md @@ -18,7 +18,6 @@ ms.reviewer: Cmdlet to submit a new migration job referenced to a previously uploaded package in Azure Blob storage into to a site collection. - ## SYNTAX ### AzureLocationsInline @@ -72,7 +71,6 @@ Type: System.String Parameter Sets: AzureLocationsInline Aliases: - Required: False Position: Named Default value: None @@ -91,7 +89,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -110,7 +107,6 @@ Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -129,7 +125,6 @@ Type: System.String Parameter Sets: AzureLocationsInline Aliases: - Required: True Position: 1 Default value: None @@ -148,7 +143,6 @@ Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsPipebind Aliases: - Required: True Position: 1 Default value: None @@ -167,7 +161,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -186,7 +179,6 @@ Type: System.String Parameter Sets: AzureLocationsInline Aliases: - Required: True Position: 2 Default value: None @@ -205,7 +197,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md index 4301cab32..d556085d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md @@ -55,7 +55,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -74,7 +73,6 @@ Type: System.Guid Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -93,7 +91,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md index a3ead0b9c..10fc90682 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md @@ -53,7 +53,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 0 Default value: None @@ -72,7 +71,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md index cd1872cd7..d88c35c48 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md @@ -75,7 +75,6 @@ Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite - Required: True Position: 0 Default value: None @@ -94,7 +93,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -113,7 +111,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md index 9c3635569..d6c86d8b3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md @@ -49,7 +49,6 @@ Type: System.String Parameter Sets: (All) Aliases: - Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-DatabaseToAvailabilityGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-DatabaseToAvailabilityGroup.md index aacbaec77..2db3dff97 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-DatabaseToAvailabilityGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-DatabaseToAvailabilityGroup.md @@ -34,16 +34,16 @@ Use the Add-DatabaseToAvailabilityGroup cmdlet to add an availability group to t ## EXAMPLES -### Example 1 +### Example 1 ``` -Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\ +Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\ ``` This example adds the database WSS_Content to the availability group named "MyAvailabilityGroup". ### Example 2 ``` -Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\ +Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\ ``` This example adds all SharePoint databases attached to the farm to the availability group named "MyAvailabilityGroup" @@ -51,13 +51,15 @@ This example adds all SharePoint databases attached to the farm to the availabil ## PARAMETERS ### -AGName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the availability group from which the databases are being added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -67,15 +69,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,14 +89,16 @@ Accept wildcard characters: False ``` ### -DatabaseName -The name of the database to be added to the availability group. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The name of the database to be added to the availability group. **Note:** This parameter should not be used in conjunction with the **ProcessAllDatabases** parameter. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,13 +108,15 @@ Accept wildcard characters: False ``` ### -FileShare + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When a database is being added to the availability group, backup / restores are done from this location to propagate the database to all replicas. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +126,15 @@ Accept wildcard characters: False ``` ### -ProcessAllDatabases + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds all databases from the current SharePoint farm into the availability group. ```yaml Type: SwitchParameter Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-FASTSearchResource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-FASTSearchResource.md index df1bb2693..6e6644267 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-FASTSearchResource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-FASTSearchResource.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>Add-FASTSearchResource dictionaries\spellcheck\check_en.aut c:\check_en.aut ``` @@ -39,13 +39,15 @@ This example uploads the file c:\check_en.aut to dictionaries\spellcheck\check_e ## PARAMETERS ### -Path + +> Applicable: FAST Server for SharePoint 2010 + Partial URI within the resource store where the file will be uploaded. ```yaml Type: String Parameter Sets: (All) Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: FAST Server for SharePoint 2010 + Path of the local resource to be uploaded. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPAppDeniedEndpoint.md index fccf9f481..8716a7618 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPAppDeniedEndpoint.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPAppDeniedEndpoint.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a relative URL endpoint of a server to the list of app-denied endpoints. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ``` Add-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" ``` @@ -43,14 +42,16 @@ Apps will not be able to access this endpoint. ## PARAMETERS ### -Endpoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a relative URL endpoint of a server that is added to the list of app-denied endpoints. Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPClaimTypeMapping.md index 7e3516b88..b0574c410 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPClaimTypeMapping.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a claim mapping to a trusted security token service (STS) identity provider. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>Get-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" | Add-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" ``` @@ -43,6 +42,9 @@ This example adds a claim mapping to a trusted identity token issuer. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the STS for the farm that will issue the security token for the identity provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, ClaimMap1); or an instance of a valid SPClaimMapping object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the farm trust Token Issuer (STS authentication provider). The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an authentication provider (for example, MyIDprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. @@ -68,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the claim mapping rule if it exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDiagnosticsPerformanceCounter.md index 5b051946b..5eb0c5065 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDiagnosticsPerformanceCounter.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a new instance of a performance counter to a Web front end computer or a database server. - ## SYNTAX ### AddCounter @@ -50,17 +49,16 @@ The Add-SPDiagnosticsPerformanceCounter cmdlet adds a performance counter to a f A performance counter is read and recorded in the usage database. By default, the new performance counter is added to the database servers in the farm. - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` C:\PS>Add-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" ``` This example adds the counter that has the name ASP.NET\Requests Queued on front end Web servers. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` C:\PS>Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. Disk Queue Length" -allinstances ``` @@ -68,7 +66,7 @@ C:\PS>Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. This example adds all instances of the counter PhysicalDisk in the category Avg. Disk Queue Length on front end Web servers. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` C:\PS>Add-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver ``` @@ -78,6 +76,9 @@ This example adds the _Total instance of the counter % Processor Time in the cat ## PARAMETERS ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category of performance counter to add to the target Web front end computer or database server. The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. @@ -85,8 +86,7 @@ The type must be a valid name of a category of performance counters; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -96,6 +96,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of counter to add to the target Web front end computer or database server. The type must be a valid name of counter type; for example, Requests Queued, Avg. @@ -103,9 +106,8 @@ Disk Queue Length, and % Processor Time. ```yaml Type: String -Parameter Sets: AddCounter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: AddCounter, AddInstance +Aliases: Required: True Position: Named @@ -114,29 +116,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -Instance Specifies the display name of the new performance counter. The type must be a valid name of a performance counter instance; for example Total_PerfCounter. ```yaml Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: AddInstance, AddMultipleCounters +Aliases: Required: True Position: Named @@ -145,27 +136,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -AllInstances -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -AllInstances Collects all instances of a counter category and type on the target Web front end computer or database server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -175,6 +155,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -186,8 +169,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -204,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -214,13 +198,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the specified performance counter to all database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +216,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the specified performance counter to all Web front end computers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +234,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -253,7 +244,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -263,13 +253,15 @@ Accept wildcard characters: False ``` ### -CounterList + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill CounterList Description}} ```yaml Type: String[] Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDistributedCacheServiceInstance.md index 643239dfd..776cd226b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPDistributedCacheServiceInstance.md @@ -17,7 +17,6 @@ ms.reviewer: Adds an instance of the distributed cache service to a local server. - ## SYNTAX ### (Default) @@ -44,10 +43,9 @@ This cmdlet contains more than one parameter set. You may only use parameters fr Use the Add-SPDistributedCacheServiceInstance cmdlet to add an instance of the distributed cache server to a local server. This is required to start the AppFabric service. - ## EXAMPLES -### Example 1 +### Example 1 ``` Add-SPDistributedCacheServiceInstance ``` @@ -58,17 +56,17 @@ This example adds an instance of the distributed cache service to a local server ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +76,9 @@ Accept wildcard characters: False ``` ### -CacheSizeInMB + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the amount of RAM to allocate for the Distributed Cache service instance. If this parameter is not specified, the default value will be used. @@ -85,8 +86,7 @@ If this parameter is not specified, the default value will be used. ```yaml Type: Int32 Parameter Sets: CacheSizeSet -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,7 +96,10 @@ Accept wildcard characters: False ``` ### -Role -Specifies the type of server role that the Distributed Cache service instance should be configured for. + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Specifies the type of server role that the Distributed Cache service instance should be configured for. This parameter is typically used when you are going to do a server role conversion to the specified server role. @@ -109,9 +112,8 @@ The valid values are: ```yaml Type: SPServerRole Parameter Sets: LocalServerRoleSet -Aliases: +Aliases: Accepted values: DistributedCache, SingleServerFarm, WebFrontEndWithDistributedCache -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduClassMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduClassMember.md index 45ebdd215..e22976888 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduClassMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduClassMember.md @@ -27,22 +27,23 @@ Not in use ## EXAMPLES -### Example 1 +### Example 1 ``` Not in use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Not in use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -ClassId + +> Applicable: SharePoint Server 2013 + Not in use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: SharePoint Server 2013 + Not in use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013 + Not in use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -UserAlias + +> Applicable: SharePoint Server 2013 + Not in use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduUser.md index 398aaff40..e580ac343 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPEduUser.md @@ -27,23 +27,24 @@ Do not use ## EXAMPLES -### Example 1 +### Example 1 ``` Do not use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -53,13 +54,15 @@ Accept wildcard characters: False ``` ### -FirstName + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -LastName + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -UserAlias + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -UserEmail + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPInfoPathUserAgent.md index 47298d620..d422619cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPInfoPathUserAgent.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------------- +### EXAMPLE ``` C:\PS>Add-SPInfoPathUserAgent -Name "NewAgent" ``` @@ -40,6 +40,9 @@ This example creates a new agent named NewAgent. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the user agent to receive InfoPath 2013 files. These user agents represent search bots that are commonly used in an enterprise environment. If a different search technology is being used and InfoPath 2013 files are not being indexed, you can add additional search bots for that technology to the collection. @@ -49,8 +52,7 @@ The type must be a valid file name; for example UserAgentName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPPluggableSecurityTrimmer.md index 4a31fd7d3..0ee1eecf7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPPluggableSecurityTrimmer.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1-------------------- +### EXAMPLE 1 ``` C:\PS>$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} C:\PS>Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 @@ -41,6 +41,9 @@ This example adds a pluggable security trimmer that is related to the User Profi ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the User Profile service application proxy to which you are adding the pluggable security trimmer. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -PlugInId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The index of the pluggable security trimmer must have an integer value greater than or equal to zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -QualifiedTypeName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the qualified type name of the class that implements the pluggable security trimmer. The type must be a valid qualified type name, in the form Microsoft.Office.Server.SocialData.SocialSecurityTrimmer,Microsoft.Office.Server.UserProfiles,Version=14.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c. @@ -121,8 +132,7 @@ The type must be a valid qualified type name, in the form Microsoft.Office.Serve ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -149,13 +161,15 @@ Accept wildcard characters: False ``` ### -CustomProperties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill CustomProperties Description}} ```yaml Type: NameValueCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileLeader.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileLeader.md index 56d11af66..63549aa29 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileLeader.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileLeader.md @@ -36,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------EXAMPLE------------ +### EXAMPLE ``` C:\PS>$upaProxy = Get-SPServiceApplicationProxy | where {$_.TypeName -eq 'User Profile Service Application Proxy'} C:\PS>Add-SPProfileLeader -ProfileServiceApplicationProxy $upaProxy -Name "contoso\janedoe" @@ -47,13 +47,15 @@ This example adds a company leader named Jane Doe. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,14 +65,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name to be added as a leader for the new User Profile Service application. For example, contoso\janedoe. ```yaml Type: SPProfileLeaderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,14 +127,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileSyncConnection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileSyncConnection.md index d5e51e6e3..b941429f0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileSyncConnection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPProfileSyncConnection.md @@ -41,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE----------- +### EXAMPLE ``` Add-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionForestName "fabrikam.com"-ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" ``` @@ -51,13 +51,15 @@ This example adds a user from the fabrikam domain using a specific user profile ## PARAMETERS ### -ProfileServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile service application. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -ConnectionDomain + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the NetBIOS name of the domain you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -ConnectionForestName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the fully qualified domain name (FQDN) of the forest you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,13 +105,15 @@ Accept wildcard characters: False ``` ### -ConnectionPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the account used for directory connection. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -115,14 +123,16 @@ Accept wildcard characters: False ``` ### -ConnectionSynchronizationOU + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the top level organizational unit (OU) that you would like to synchronize. The value must be a domain name and you can only include one container per command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -ConnectionUserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to be used for the synchronization connection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -159,8 +174,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +184,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -177,7 +194,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -187,13 +203,15 @@ Accept wildcard characters: False ``` ### -ConnectionClaimIDMapAttribute + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Claims ID used by the Claim Provider, that is, samAccountName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +221,15 @@ Accept wildcard characters: False ``` ### -ConnectionClaimProviderIdValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Claims Provider ID or Name for an authentication type while a Web App is configured. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +239,9 @@ Accept wildcard characters: False ``` ### -ConnectionClaimProviderTypeValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Authentication claim Provider that will be used to encode the User Profile accounts names. For example, Windows/Forms etc. This means if a user logs in using the given Authentication Type, then a profile can be found by looking up a claim encoded credentials. @@ -226,8 +249,7 @@ This means if a user logs in using the given Authentication Type, then a profile ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,13 +259,15 @@ Accept wildcard characters: False ``` ### -ConnectionNamingContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the naming context of the directory information tree to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -253,14 +277,16 @@ Accept wildcard characters: False ``` ### -ConnectionPort + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the port to be used to connect to the directory service. The default port is 389. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -270,13 +296,15 @@ Accept wildcard characters: False ``` ### -ConnectionServerName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the domain controller to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -286,6 +314,9 @@ Accept wildcard characters: False ``` ### -ConnectionUseSSL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the connection to the directory service must be over SSL. The valid values are: $True or $False @@ -293,8 +324,7 @@ The valid values are: $True or $False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -304,6 +334,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -311,7 +344,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -321,13 +353,15 @@ Accept wildcard characters: False ``` ### -ConnectionFilterOutUnlicensed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -337,16 +371,18 @@ Accept wildcard characters: False ``` ### -ConnectionUseDisabledFilter + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters out disabled accounts. ->[!NOTE] +>[!NOTE] This will only filter out accounts which are in a disabled state prior to being imported. It will not filter out accounts which have been disabled after importing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachineInfo.md index 3eac60c3b..369777c2c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachineInfo.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a new routing target to the farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ Use the Add-SPRoutingMachineInfo cmdlet to add a new routing target to the farm ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -48,13 +47,15 @@ This example adds a routing target for a specified identity to the farm. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to add to the routing target. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +65,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the computer to add to the route. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not the added computer will be available for routing. The valid values are: @@ -112,8 +120,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -OutgoingPort + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the port used by Request Manager to make an outgoing connection. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +148,9 @@ Accept wildcard characters: False ``` ### -OutgoingScheme + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines the Http scheme of outgoing connections. The valid values are: @@ -150,8 +162,7 @@ The valid values are: ```yaml Type: SPRoutingOutgoingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +172,16 @@ Accept wildcard characters: False ``` ### -StaticWeight + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the static weight of a computer routing that is used by Request Manager. If the static weight is higher, more requests will be routed to the computer. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachinePool.md index beceb80c9..79fcdc5aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingMachinePool.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a new machine pool. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -47,13 +46,15 @@ This example adds a machine pool. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to add to the routing machine pool. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of machine pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -MachineTargets + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the routing targets collection that the machine pool will contain. ```yaml Type: SPRoutingRuleTargetPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingRule.md index 2bdb82299..c2437f5a7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPRoutingRule.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a routing rule. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------- +### EXAMPLE ``` C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web @@ -50,13 +49,15 @@ This examples adds a routing rule to the farm by using the $rm and $machines var ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to add to the routing rule. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ExecutionGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the group in which the rule will be placed. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -MachinePool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the pool of machines to which a request will be routed if the created rule is matched. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPScaleOutDatabase.md index 425b97db9..eb29b24a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPScaleOutDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Adds an existing scale-out database to the specified service application. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ``` C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" @@ -46,13 +45,15 @@ This example adds a new or existing scale out database into a specific service a ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to add to the specified service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the owner's credentials of the scale-out database to be added to the service application. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the failover server for the scale-out database to be added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +160,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the server hosting the scale-out database to be added. If a value is not provided, the default database server will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill DeferUpgradeActions Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSecureStoreSystemAccount.md index d3c3376ed..817f821d2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSecureStoreSystemAccount.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE---------- +### EXAMPLE ``` C:\PS>Add-SPSecureStoreSystemAccount -AccountName contoso\jdoe ``` @@ -39,13 +39,15 @@ This example adds the account name jdoe. ## PARAMETERS ### -AccountName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServerScaleOutDatabase.md index 30d15890d..f9c8f6747 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServerScaleOutDatabase.md @@ -16,7 +16,6 @@ ms.reviewer: Adds an existing scale-out content database to the specified service application. - ## SYNTAX ``` @@ -32,7 +31,7 @@ Use the Add-SPServerScaleOutDatabase cmdlet to add an existing scale-out databas ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ``` $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Add-SPServerScaleOutDatabase -ServiceApplication $serviceApplication @@ -40,18 +39,18 @@ Add-SPServerScaleOutDatabase -ServiceApplication $serviceApplication This example adds a new or existing scale out database into a specific service application. - ## PARAMETERS ### -DatabaseName +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to add to the specified service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +61,14 @@ Accept wildcard characters: False ### -ServiceApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +79,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +103,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -120,13 +122,14 @@ Accept wildcard characters: False ### -DatabaseCredentials +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the owner's credentials of the scale-out database to be added to the service application. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,13 +140,14 @@ Accept wildcard characters: False ### -DatabaseFailoverServer +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the failover server for the scale-out database to be added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,14 +158,15 @@ Accept wildcard characters: False ### -DatabaseServer +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the server hosting the scale-out database to be added. If a value is not provided, the default database server will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +177,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -189,13 +195,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions -Specifies whether upgrade actions are deferred duringi an Upgrade process. + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether upgrade actions are deferred duringi an Upgrade process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServiceApplicationProxyGroupMember.md index 09ec7f008..87baf9dd6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServiceApplicationProxyGroupMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPServiceApplicationProxyGroupMember.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a member to the service application proxy group. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -match 'User Profile Service Application Proxy'} Add-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member $proxy @@ -48,13 +47,15 @@ Use this result for any other SPServiceApplicationProxyGroup cmdlets. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application proxy group to which to add the member. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +65,15 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an array of members to add to the service application proxy group. ```yaml Type: SPServiceApplicationProxyPipeBind[] Parameter Sets: (All) Aliases: Proxy -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 2 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPShellAdmin.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPShellAdmin.md index c5911f4eb..31ddae053 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPShellAdmin.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPShellAdmin.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a user to the SharePoint_Shell_Access role for the specified database. - ## SYNTAX ``` @@ -50,28 +49,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1------------------------- +### EXAMPLE 1 ``` Add-SPShellAdmin -UserName CONTOSO\User1 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in the farm configuration database only, and also ensures the user is added to the WSS_Admin_WPG local group on each server in the farm. -### -------------------EXAMPLE 2------------------------- +### EXAMPLE 2 ``` Add-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified content database and the configuration database by passing a database GUID to the cmdlet. -### -------------------EXAMPLE 3------------------------- +### EXAMPLE 3 ``` Get-SPDatabase | Where-Object {$_.WebApplication -like "SPAdministrationWebApplication"} | Add-SPShellAdmin CONTOSO\User1 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified Central Administration content database and the configuration database. -### -------------------EXAMPLE 4------------------------- +### EXAMPLE 4 ``` Get-SPDatabase | ?{$_.Name -eq "WSS_Content"} | Add-SPShellAdmin -Username CONTOSO\User1 ``` @@ -81,13 +80,15 @@ This example adds a new user named User1 to the SharePoint_Shell_Access role of ## PARAMETERS ### -UserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the user to add to the SharePoint_Shell_Access role in the target database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -97,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +112,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -database + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the database or the Database object that includes the SharePoint_Shell_Access role to which you want to add the user. If the database parameter is not specified, the configuration database is used. The farm configuration database is always included, even if you specify another database. @@ -143,8 +151,7 @@ The farm configuration database is always included, even if you specify another ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -161,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionFeaturePackMember.md index d3b9b0d51..7300ae48a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionFeaturePackMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionFeaturePackMember.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a feature to a SharePoint Feature set. - ## SYNTAX ``` @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------------- +### EXAMPLE ``` $fp = New-SPSiteSubscriptionFeaturePack Get-SPFeature -limit all | Where{ $_.Scope -eq "WEB" } | Add-SPSiteSubscriptionFeaturePackMember -id $fp @@ -50,6 +49,9 @@ The Feature set is refreshed in the last line so that the local object has the c ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Feature set object or GUID to which the given SharePoint Feature is added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a Feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -57,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -68,13 +69,15 @@ Accept wildcard characters: False ``` ### -FeatureDefinition + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Feature definition, name, or GUID to add to the Feature set. ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +101,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -113,7 +121,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionProfileConfig.md index c47babc12..b4420f41d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSiteSubscriptionProfileConfig.md @@ -44,7 +44,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ``` $sub = Get-SPSiteSubscription https://contoso/my $proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} @@ -57,6 +57,9 @@ This example creates a new User Profile Service application tenant. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application to add the site subscription to. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -64,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -75,15 +77,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the My Site host for the site subscription is provisioned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -92,27 +96,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -ProfileServiceApplicationProxy -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -ProfileServiceApplicationProxy Specifies the identifier for the User Profile Service Application proxy where the tenant is to be created. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -122,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -133,8 +129,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -161,6 +158,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -168,8 +168,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +178,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -197,8 +199,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +209,9 @@ Accept wildcard characters: False ``` ### -SynchronizationOU + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the organizational unit serving the site subscription. The type must be a valid name of an organizational unit; for example, OrgUnit1. @@ -215,8 +219,7 @@ The type must be a valid name of an organizational unit; for example, OrgUnit1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +229,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -233,7 +239,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSolution.md index abe0855c2..9f833a8e9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPSolution.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Add-SPSolution -LiteralPath c:\contoso_solution.wsp ``` @@ -42,6 +42,9 @@ This example adds the SharePoint solution in the file contoso_solution.wsp to th ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path to the solution package. The type must be a valid path in either of the following forms: @@ -52,8 +55,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +108,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language pack to install with the solution package. The type must be a valid language identifier; for example, 1033. @@ -109,8 +118,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +128,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPThrottlingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPThrottlingRule.md index 400890c5f..3848ce8ed 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPThrottlingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPThrottlingRule.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a new throttling rule. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ``` $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -46,13 +45,15 @@ This example adds a throttling rule for a specified identity by using the $rm an ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to add. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the throttling rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +141,16 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a value between 0 and 10 which defines the maximum threshold for throttling. The Request Manager will remove routing targets if their Health-Score becomes greater than this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserLicenseMapping.md index 368adaa6a..4f926319a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserLicenseMapping.md @@ -17,7 +17,6 @@ ms.reviewer: Maps a security group, forms-based role, or claim to a SharePoint user license. - ## SYNTAX ``` @@ -39,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1------------------- +### EXAMPLE 1 ``` $a = New-SPUserLicenseMapping -SecurityGroup yoursecuritygroup -License Enterprise Add-SPUserLicenseMapping -Mapping $a @@ -50,11 +49,13 @@ This example adds user mappings for the entire farm. ## PARAMETERS ### -Mapping + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserSolution.md index 7efcef26e..6ca67d0e9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Add-SPUserSolution.md @@ -17,7 +17,6 @@ ms.reviewer: Uploads a new sandboxed solution to the solution gallery. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ``` Add-SPUserSolution -LiteralPath c:\contoso_solution.wsp -Site https://sitename ``` @@ -43,6 +42,9 @@ This example adds the sandboxed solution c:\contoso_solution.wsp to the site htt ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path to the sandboxed solution package. The type must be a valid path in either of the following forms: @@ -53,8 +55,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the sandboxed solution is to be added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSiteobject. @@ -71,8 +75,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPConfigurationDatabase.md index 813ab13d5..45ea0e28f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPConfigurationDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Performs a farm-level configuration-only backup. - ## SYNTAX ### DefaultSet @@ -49,14 +48,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1-------------------- +### EXAMPLE 1 ``` Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -ShowTree ``` This example displays components that are available for inclusion in a configuration-only backup. -### -------------------EXAMPLE 2-------------------- +### EXAMPLE 2 ``` Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -Verbose ``` @@ -66,6 +65,9 @@ This example performs a configuration-only backup with verbose output. ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path where SharePoint Products stores the backup package it generates. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -84,8 +86,7 @@ The spbr* folders are automatically created. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -95,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID and password that corresponds to the administrator user name for the SQL Server database. This parameter should only be specified if SQL authentication is used to connect to the database. @@ -125,8 +131,7 @@ If Windows authentication is used to connect to the database, then this paramete ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the configuration database name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +159,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL database server that contains the configuration database. The default value is the local computer name. @@ -160,8 +170,7 @@ The type must be a valid database server; for example, DS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates the part of the farm to back up. You may use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items match the name, the full path must be provided. @@ -181,8 +193,7 @@ If the Item parameter is not specified, the entire farm configuration is backed ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -192,6 +203,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays which objects in the farm will be backed up based on the other parameters passed to the backup cmdlet, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPConfigurationDatabase cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets (\[ \]). @@ -200,8 +214,7 @@ A backup will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPEnterpriseSearchServiceApplicationIndex.md index 6ab5c1d5a..70ac12d96 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPEnterpriseSearchServiceApplicationIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPEnterpriseSearchServiceApplicationIndex.md @@ -34,27 +34,26 @@ Backup-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the phase of the backup job. ```yaml Type: Int32 Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -90,13 +91,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Name of the search service application to be backed up ```yaml Type: SearchServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -BackupFolder + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Full UNC path of the backup files should be written. ```yaml Type: String Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 3 @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -BackupHandleFile + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a file handle for an ongoing backup job. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 4 @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -Retries + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Number of times to retry if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 5 @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -165,8 +177,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -200,7 +216,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -210,13 +225,15 @@ Accept wildcard characters: False ``` ### -Abort + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill Abort Description}} ```yaml Type: SwitchParameter Parameter Sets: AbortBackup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -226,13 +243,15 @@ Accept wildcard characters: False ``` ### -PeerToPeer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill PeerToPeer Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -242,13 +261,15 @@ Accept wildcard characters: False ``` ### -SpecifiedBackupHandle + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill SpecifiedBackupHandle Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPFarm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPFarm.md index dca6bf272..474a967b8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPFarm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPFarm.md @@ -17,7 +17,6 @@ ms.reviewer: Creates a backup of an individual database, Web application, or the entire farm. - ## SYNTAX ### DefaultSet @@ -48,28 +47,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Backup-SPFarm -Directory \\file_server\share\Backup -BackupMethod full -ConfigurationOnly ``` This example backs up the configuration settings of the farm to the \\\\file_server\share\Backup directory. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Backup-SPFarm -ShowTree -Item "Microsoft SharePoint Foundation Web Application" -Verbose ``` This example shows which components of the farm would be backed up under the "Microsoft SharePoint Foundation Web Application" node, but do not actually back them up. -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Backup-SPFarm -Directory C:\Backup -BackupMethod full -BackupThreads 10 -Force ``` This example performs a backup of a farm using 10 threads and forces the backup to be saved to the C:\Backup directory even though SharePoint estimates that it does not have sufficient space available. -### --------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ``` Backup-SPFarm -ShowTree ``` @@ -79,6 +78,9 @@ This example shows you the available objects to backup with `Backup-SPFarm`. ## PARAMETERS ### -BackupMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of backup file to be created. If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used. @@ -95,8 +97,7 @@ The type must be either of the following: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -106,6 +107,9 @@ Accept wildcard characters: False ``` ### -Directory + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path where SharePoint Products stores the backup package it generates. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -124,8 +128,7 @@ The spbr* folders are automatically created. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -135,6 +138,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays which objects in the farm will be backed up based on the other parameters passed to the Backup-SPFarm cmdelt, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPFarm cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets (\[ \]). @@ -143,8 +149,7 @@ A backup will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -154,6 +159,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -165,8 +173,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +183,9 @@ Accept wildcard characters: False ``` ### -BackupThreads + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of threads to be used during the backup. The fewer the threads, the easier the backup log file is to read and understand. The more the threads, the more components that can be backed up in parallet, potentially resulting in a faster backup operation. @@ -188,8 +198,7 @@ If a backup is performed with the -ShowTree parameter, then the BackupMethod par ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +208,9 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If set, the backup will contain configuration settings only (no data) for each of the objects to be backed up. SharePoint may overestimate the amount of space required for a configuration-only backup, which may result in SharePoint estimating that it doesn't have sufficient space to store the backup at the specified path. Use the `-Force` parameter in this situation to proceed with the backup if you have sufficient space to store the configuration-only backup. @@ -206,8 +218,7 @@ SharePoint may overestimate the amount of space required for a configuration-onl ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +228,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to proceed with a backup operation even if the estimation is that the backup directory does not have sufficient space to hold the entire backup. If a backup is performed with the ShowTree parameter, then the Force parameter is not used. @@ -224,8 +238,7 @@ If a backup is performed with the ShowTree parameter, then the Force parameter i ```yaml Type: SwitchParameter Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates the part of the farm to back up. You might use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items are included in the same match, the full path must be provided. @@ -247,8 +263,7 @@ The type must be a valid item; for example, Farm\Microsoft SharePoint Foundation ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -258,6 +273,9 @@ Accept wildcard characters: False ``` ### -Percentage + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Requests progress updates about the backup operation to be displayed in increments of that percentage; for example, a value of 5 displays backup progress updates at every 5 percent completed, and a value of 10 displays backup progress updates at every 10 percent completed. To have progress outputs displayed, you must specify the Verbose parameter. @@ -274,8 +292,7 @@ Valid values are an integer value between 1 and 100. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -285,6 +302,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -292,7 +312,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -302,13 +321,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPSite.md index bada209fa..e46cda24a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Backup-SPSite.md @@ -17,7 +17,6 @@ ms.reviewer: Performs a backup of a site collection. - ## SYNTAX ``` @@ -35,15 +34,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1-------------------- +### EXAMPLE 1 ``` Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak ``` This example backs up a site collection at https://server_name/sites/site_name to the C:\Backup\site_name.bak file. - -### -------------------EXAMPLE 2-------------------- +### EXAMPLE 2 ``` Get-SPSiteAdministration https://server_name/sites/site_name | Backup-SPSite -Path C:\Backup\site_name.bak ``` @@ -51,14 +49,14 @@ Get-SPSiteAdministration https://server_name/sites/site_name | Backup-SPSite -Pa This example backs up a site collection at https://server_name/sites/site_name to the C:\Backup\site_name.bak file. Same result as Example 1, but a different way of performing the operation. -### -------------------EXAMPLE 3-------------------- +### EXAMPLE 3 ``` Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -UseSqlSnapshot ``` This example backs up a site collection using database snapshots to ensure backup integrity. -### -------------------EXAMPLE 4-------------------- +### EXAMPLE 4 ``` Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -NoSiteLock ``` @@ -68,6 +66,9 @@ This example backs up a site collection and prevents placing the site into a rea ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to be backed up. For example, a valid URL, such as https://server_name/sites/site_name or a GUID such as, "01234567-89ab-cdef-0123-456789abcdef" @@ -75,8 +76,7 @@ For example, a valid URL, such as https://server_name/sites/site_name or a GUID ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,13 +86,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full path to the backup file (that is, C:\Backup\site_name.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +118,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,13 +147,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specify to overwrite an existing backup file if it already exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +165,9 @@ Accept wildcard characters: False ``` ### -NoSiteLock + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection to remain read and write during the backup. If the NoSiteLock parameter is not specified, then a site collection that has a site collection lock setting of "none" or "no additions" will be temporarily set to "read only" while the site collection backup is performed. @@ -168,8 +179,7 @@ If users are writing to the site collection while the site collection is being b ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +189,9 @@ Accept wildcard characters: False ``` ### -UseSqlSnapshot + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a SQL Database Snapshot will be created when the backup begins, and all site collection data will be retrieved directly from the database snapshot. This snapshot will be deleted automatically when the backup completes @@ -189,8 +202,7 @@ It is not necessary to specify the NoSiteLock parameter when specifying the UseS ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +212,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -207,7 +222,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -217,13 +231,15 @@ Accept wildcard characters: False ``` ### -UseABSDocStreamInfo + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-FASTSearchContentCollection.md index 33e78197a..ad030d031 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-FASTSearchContentCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-FASTSearchContentCollection.md @@ -28,14 +28,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>Clear-FASTSearchContentCollection -Name newscollection ``` This example clears the content of the "newscollection" content collection. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>Clear-FASTSearchContentCollection -Name newscollection -Force ``` @@ -46,13 +46,15 @@ The user does not have to confirm the operation. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the content collection to clear. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. @@ -73,7 +78,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings so the user is not asked to confirm the operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -106,7 +115,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPAppDeniedEndpointList.md index f46c1f36b..28d8dba8c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPAppDeniedEndpointList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPAppDeniedEndpointList.md @@ -30,21 +30,21 @@ Use the Clear-SPAppDeniedEndpoint cmdlet to remove all app-denied endpoints in t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ``` Clear-SPAppDeniedEndpoint ``` This example removes all app-denied endpoints from the farm. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,12 +55,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,17 +69,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -92,18 +90,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPBusinessDataCatalogEntityNotificationWeb.md index f97a10c2a..615a87720 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPBusinessDataCatalogEntityNotificationWeb.md @@ -17,7 +17,6 @@ ms.reviewer: Clears the entity notification site. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ``` Clear-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso" ``` @@ -42,13 +41,15 @@ This example clears the entity notification site for the service context corresp ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the dervice context for which the entity notification web has to be cleared. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPContentDatabaseSyncData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPContentDatabaseSyncData.md index 7b65faf32..5ebb45015 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPContentDatabaseSyncData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPContentDatabaseSyncData.md @@ -37,6 +37,9 @@ This example resets synchronization information from the content databases that ## PARAMETERS ### -DaysSinceLastProfileSync + +> Applicable: SharePoint Server 2019 + Specifies the least number of days by which the databases are old. The default value of this parameter is 0. @@ -45,7 +48,7 @@ The default value of this parameter is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2019 + Required: False Position: 1 Default value: None @@ -54,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,7 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -75,13 +81,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -90,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -97,7 +109,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPDistributedCacheItem.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPDistributedCacheItem.md index e094761e7..7647b0308 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPDistributedCacheItem.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPDistributedCacheItem.md @@ -17,7 +17,6 @@ ms.reviewer: Clears cached items from the distributed cache server. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------ +### EXAMPLE ``` Clear-SPDistributedCacheItem -ContainerType DistributedLogonTokenCache ``` @@ -43,6 +42,8 @@ This example removes all the cache items for distributed token cache. ### -ContainerType +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the container type to clear. The valid values for SharePoint Server 2013 and SharePoint Server 2016 are the following: @@ -54,12 +55,10 @@ Additional valid values for SharePoint Server 2016 are the following: DistributedSharedWithUserCache, DistributedUnifiedGroupsCache, DistributedFileLockThrottlerCache, DistributedResourceTallyCache, DistributedHealthScoreCache, DistributedClientSideAppUpdateTimeCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +102,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPLogLevel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPLogLevel.md index 0eab3e772..976d21706 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPLogLevel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPLogLevel.md @@ -17,7 +17,6 @@ ms.reviewer: Resets the Windows event logging and trace logging to their default values. - ## SYNTAX ``` @@ -33,28 +32,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Clear-SPLogLevel -Identity Cat1 ``` This example resets the log levels for a single category. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` "Cat1", "Cat2", "Cat3" | Clear-SPLogLevel ``` This example resets the log levels for multiple categories. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Get-SPLogLevel | Clear-SPLogLevel ``` This example resets the log levels for all categories. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Clear-SPLogLevel -Identity "SharePoint Server:Database" ``` @@ -64,6 +63,9 @@ This example resets the log level for the specific category in the SharePoint Se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event throttling setting is applied to all categories in the farm. @@ -94,8 +98,7 @@ Providing an invalid category is a non-terminating error and will be ignored. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result of the InputObject parameter to be piped. The value can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, modify their values, and then pipe the results to the Set-SPLogLevel cmdlet. @@ -112,8 +118,7 @@ The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, mod ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPMetadataWebServicePartitionData.md index 2af0215d1..36f105b30 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPMetadataWebServicePartitionData.md @@ -38,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ``` Clear-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` @@ -48,6 +48,9 @@ This example removes data for a site subscription on a Metadata Service applicat ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription configuration to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -55,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -73,8 +78,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,13 +112,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -122,13 +130,15 @@ Accept wildcard characters: False ``` ### -FromContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +148,15 @@ Accept wildcard characters: False ``` ### -FromServiceDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPPerformancePointServiceApplicationTrustedLocation.md index 265d4fd46..395956f4d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPPerformancePointServiceApplicationTrustedLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPPerformancePointServiceApplicationTrustedLocation.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Clear-SPPerformancePointServiceApplicationTrustedLocation -ServiceApplication My_Service_Application ``` @@ -42,6 +42,9 @@ This example removes trusted locations from the Service application named, My_Se ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application that contains the trusted locations. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -49,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -TrustedLocationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of trusted locations to clear. If the TrustedLocationType parameter is not specified, this cmdlet clears all the trusted locations for the specified PerformancePoint Service application. @@ -107,8 +116,7 @@ The type must be one of the following: content, data source. ```yaml Type: TrustedFileType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseDeletedDataSubRange.md index eba2a9bd6..ca975bd6c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseDeletedDataSubRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseDeletedDataSubRange.md @@ -17,7 +17,6 @@ ms.reviewer: Clears all partitions inside the specified deleted subrange. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ``` $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -49,13 +48,15 @@ The example then clears that subrange and all data in the partitions in the subr ## PARAMETERS ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to clear the deleted subrange from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,13 +66,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +116,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseLog.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseLog.md index ce1771ced..6628bdf8e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseLog.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseLog.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ``` $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -42,13 +42,15 @@ This example removes all scale-out log entries in the first scale-out database o ## PARAMETERS ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database from which to clear the logs. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,14 +103,16 @@ Accept wildcard characters: False ``` ### -LogEntryTimeout + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time-out value in minutes for the log entries. If there is at least one log entry which is more recent than this value, no log entries will be deleted. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseTenantData.md index 22d117afd..f13854102 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPScaleOutDatabaseTenantData.md @@ -17,7 +17,6 @@ ms.reviewer: Removes all data related to the specified site subscription. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ``` Clear-SPScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -43,13 +42,15 @@ This example clears all data related to the site subscription with id 5CAF2F99-A ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application in which to clear data. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription id of the site subscription in which to clear data. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreCredentialMapping.md index 0eaabcbe3..835813ccc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreCredentialMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreCredentialMapping.md @@ -40,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" $userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName @@ -52,13 +52,15 @@ This example deletes the credential mapping from the target application ContosoT ## PARAMETERS ### -All + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the principal is deleted from all Secure Store applications. ```yaml Type: SwitchParameter Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -68,13 +70,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: OneApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPClaims object that contains the principal. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,13 +106,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the credential mapping will be deleted. ```yaml Type: SPServiceContextPipeBind Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +138,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -155,6 +167,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +177,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreDefaultProvider.md index 68bd9c87e..f0eb522fc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreDefaultProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSecureStoreDefaultProvider.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Clear-SPSecureStoreDefaultProvider ``` @@ -38,6 +38,9 @@ This example clears the secure store provider. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md index 3dc4a0424..3e36c4eee 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md @@ -16,7 +16,6 @@ ms.reviewer: Clears all partitions inside the specified deleted subrange. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database Use the Clear-SPServerScaleOutDatabaseDeletedDataSubRange cmdlet to clear all partitions inside the specified deleted subrange that are contained within a specified scale-out database. - ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ``` $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -46,18 +44,18 @@ Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database $database -Range $st This example creates a deleted subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. The example then clears that subrange and all data in the partitions in the subrange. - ## PARAMETERS ### -Database +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to clear the deleted subrange from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -68,13 +66,14 @@ Accept wildcard characters: False ### -IsUpperSubRange +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,13 +84,14 @@ Accept wildcard characters: False ### -Range +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +102,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +115,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +126,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -143,6 +145,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseLog.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseLog.md index a1ccf5eb0..b0b0b7ac1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseLog.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseLog.md @@ -16,7 +16,6 @@ ms.reviewer: Clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. - ## SYNTAX ``` @@ -31,7 +30,7 @@ Use the Clear-SPServerScaleOutDatabaseLog cmdlet clears all scale-out logs in th ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ``` $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -40,18 +39,18 @@ Clear-SPServerScaleOutDatabaseLog -Database $database -LogEntryTimeout 30 This example removes all scale-out log entries in the first scale-out database of the specified service application unless there is a scale-out log entry which is more recent than 30 minutes. - ## PARAMETERS ### -Database +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database from which to clear the logs. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +61,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +85,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,14 +104,15 @@ Accept wildcard characters: False ### -LogEntryTimeout +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time-out value in minutes for the log entries. If there is at least one log entry which is more recent than this value, no log entries will be deleted. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +123,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseTenantData.md index e615bd815..6a36275f9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPServerScaleOutDatabaseTenantData.md @@ -30,10 +30,9 @@ Use the Clear-SPServerScaleOutDatabaseTenantData cmdlet removes all data related - ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ``` Clear-SPServerScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -44,13 +43,14 @@ This example clears all data related to the site subscription with id 5CAF2F99-A ### -ServiceApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application in which to clear data. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +61,14 @@ Accept wildcard characters: False ### -SiteSubscriptionId +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription id of the site subscription in which to clear data. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +79,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +103,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +122,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md index b089cef0f..c500f95d4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Deletes all data from the Business Data Connectivity Metadata Store for a specified partition. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Clear-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso ``` @@ -42,13 +41,15 @@ This example deletes all data from the Business Data Connectivity Metadata Store ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the Business Data Connectivity models are deleted. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Connect-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Connect-SPConfigurationDatabase.md index 277773d35..c9057bf2e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Connect-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Connect-SPConfigurationDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Connects the local server computer to a farm. - ## SYNTAX ``` @@ -40,7 +39,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Connect-SPConfigurationDatabase -DatabaseServer "ServerName\InstanceName" -DatabaseName "SharePointConfigurationDatabaseName" -Passphrase (ConvertTo-SecureString "MyP@ssw0rd" -AsPlainText -Force) Start-Service SPTimerv4 @@ -51,6 +50,9 @@ This example joins the local server computer to a farm that is configured to use ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the configuration database to which to connect the server. The type must be a valid database name; for example, DB1. @@ -58,8 +60,7 @@ The type must be a valid database name; for example, DB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,14 +70,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server on which to create the configuration database. The default value is the local computer name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Passphrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the secure password phrase for connecting the current server to the configuration database. The type must be a valid secure string; for example, MyBDCApp1serverkey. @@ -93,8 +99,7 @@ The type must be a valid secure string; for example, MyBDCApp1serverkey. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 9 @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -SkipRegisterAsDistributedCacheHost + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). Use this parameter to not register the server computer as a distributed cache host. @@ -112,8 +120,7 @@ If you want to have a dedicated cache host, then use this parameter to make sure ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 10 @@ -123,6 +130,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,8 +144,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If this parameter is not specified, the current user is used. @@ -153,8 +165,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailOverPartner + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the Database Mirroring partner for a SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -LocalServerRole + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the MinRole assigned to the local server. ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Convert-SPWebApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Convert-SPWebApplication.md index c4876b327..05e2340bd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Convert-SPWebApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Convert-SPWebApplication.md @@ -17,7 +17,6 @@ ms.reviewer: Converts the authentication mode of a web application. - ## SYNTAX ``` @@ -37,14 +36,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ``` Convert-SPWebApplication -Identity "https://" -To Claims -RetainPermissions ``` This example converts a web application specified by the Identity parameter to use the claim authentication mode. -### ------------EXAMPLE 2------- +### EXAMPLE 2 ``` Convert-SPWebApplication -Identity "https://" -From Legacy -To Claims -RetainPermissions ``` @@ -54,13 +53,15 @@ This example converts a web application specified by the Identity parameter from ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the web application that you want to convert, for example: https://mysite/app1 ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication method to convert from. Valid values for this parameter are as follows. @@ -79,8 +83,7 @@ Legacy, Claims-Windows, Claims-Trusted-Default ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -To + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication method to convert to. Valid values for this parameter are as follows. @@ -99,8 +105,7 @@ Claims, Claims-Windows, Claims-Trusted-Default, Claims-SharePoint-Online ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +129,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the conversion of the web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -RetainPermissions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which the cmdlet is run and retains the permission in the web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the content database to migrate. ```yaml Type: SPContentDatabase Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +193,15 @@ Accept wildcard characters: False ``` ### -MapList + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a file containing as list of rows in the following format: user-key, migrated-user-name, migrated-user-key. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -SiteSubsriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID fo the Site Subscription. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -212,13 +229,15 @@ Accept wildcard characters: False ``` ### -SkipPolicies + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWebApplication security policies will not be migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -228,13 +247,15 @@ Accept wildcard characters: False ``` ### -SkipSites + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWebApplication's SPSites will not be migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -244,13 +265,15 @@ Accept wildcard characters: False ``` ### -SourceSkipList + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a file containing as list of rows in the following format: user-key. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +283,15 @@ Accept wildcard characters: False ``` ### -TrustedProvider + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When you migrate from a trusted login provider this is how you specify which trusted login provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +301,15 @@ Accept wildcard characters: False ``` ### -LoggingDirectory + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies a directory where verbose logs about the results of the migration will be written. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPAccessServicesDatabaseCredentials.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPAccessServicesDatabaseCredentials.md index 70eaeaa92..08240b0fb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPAccessServicesDatabaseCredentials.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPAccessServicesDatabaseCredentials.md @@ -39,13 +39,15 @@ Copies the database credentials for the Access Services database "MyDatabase" fr ## PARAMETERS ### -AppUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URL of the Access app. This URL is the URL of the Access app when you open it on a SharePoint site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -ServerCredential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Credential used to connect to the source server. ```yaml Type: NetworkCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,13 +95,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the realm needs to be displayed. For example, a SharePoint site URL. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,13 +113,15 @@ Accept wildcard characters: False ``` ### -SourceServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Source SQL Server name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,13 +131,15 @@ Accept wildcard characters: False ``` ### -TargetServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Destination SQL Server name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPActivitiesToWorkflowService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPActivitiesToWorkflowService.md index 2b395e7b9..f4f2cd066 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPActivitiesToWorkflowService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPActivitiesToWorkflowService.md @@ -16,7 +16,6 @@ ms.reviewer: Copies the Workflow Activities from SharePoint to Workflow Manager. Activities are defined within Microsoft provided or custom coded assemblies. - ## SYNTAX ``` @@ -30,7 +29,7 @@ Copies Workflow activities from SharePoint Server to Workflow Manager. ## EXAMPLES -### Example 1 +### Example 1 ``` $credential = [System.Net.CredentialCache]::DefaultNetworkCredentials $site = Get-SPSite @@ -39,22 +38,20 @@ $svcAddress = $proxy.GetWorkflowServiceAddress($site) Copy-SPActivitiesToWorkflowService -WorkflowServiceAddress $svcAddress -Credential $credential -Force $true ``` - Copies the Workflow activities from SharePoint to the Workflow Manager farm using the specified Site Collection URL as a reference. - ## PARAMETERS ### -ActivityName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Copies a specific ActivityName. If not specified, all Activities are copied. ```yaml Type: String Parameter Sets: (All) -Aliases: - -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - +Aliases: Required: False Position: Named @@ -64,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +81,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,13 +99,15 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The credential used to connect to Workflow Manager. ```yaml Type: ICredentials Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,13 +117,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces a specific Activity to be copied to Workflow Manager. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -137,7 +145,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -147,14 +154,15 @@ Accept wildcard characters: False ``` ### -WorkflowServiceAddress -The Workflow Manager farm endpoint URL. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The Workflow Manager farm endpoint URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPBusinessDataCatalogAclToChildren.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPBusinessDataCatalogAclToChildren.md index e0e6453d0..f2eeb7b4a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPBusinessDataCatalogAclToChildren.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPBusinessDataCatalogAclToChildren.md @@ -17,7 +17,6 @@ ms.reviewer: Copies a set of permissions of a Business Data Connectivity Metadata Store metadata object to its child objects. - ## SYNTAX ``` @@ -58,7 +57,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ExternalSystem = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext https://contoso -Name "ContosoDatabase" ``` @@ -71,13 +70,15 @@ Make sure that the parent metadata object has the final permissions you want, or ## PARAMETERS ### -MetadataObject + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity metadata object. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -133,7 +141,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPContentTypes.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPContentTypes.md index b55f103b1..64e41413f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPContentTypes.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPContentTypes.md @@ -28,16 +28,19 @@ This cmdlet is used in hybrid scenarios with SharePoint Online to copy Content T ## EXAMPLES -### Example 1 +### Example 1 ``` -Copy-SPContentTypes -LocalSiteUrl https://localsite/ -LocalTermStoreName "managed metadata service application proxy" -RemoteSiteUrl https://contoso.sharepoint.com/ -ContentTypeNames @("ContentTypeA", "ContentTypeB") -Credential (Get-Credential) +Copy-SPContentTypes -LocalSiteUrl https://localsite/ -LocalTermStoreName "managed metadata service application proxy" -RemoteSiteUrl https://contoso.sharepoint.com/ -ContentTypeNames @("ContentTypeA", "ContentTypeB") -Credential (Get-Credential) ``` -This example migrates the specified content types named: ContentTypeA, ContentTypeB on the local site https://localsite/ whose term store named "managed metadata service application proxy" to the hub site of remote site https://contoso.sharepoint.com/. If the remote site is a hub site, the migration target will be itself. +This example migrates the specified content types named: ContentTypeA, ContentTypeB on the local site https://localsite/ whose term store named "managed metadata service application proxy" to the hub site of remote site https://contoso.sharepoint.com/. If the remote site is a hub site, the migration target will be itself. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -AuthEndpoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the AuthEndpoint to use, but not the default one. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -ContentTypeNames -Specifies the content type names to be migrated. Can be in a form of an array. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the content type names to be migrated. Can be in a form of an array. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the administrator account credential of the target SharePoint Online site. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,13 +112,15 @@ Accept wildcard characters: False ``` ### -GraphApiEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GraphApiEndpoint to use, but not the default one. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +130,15 @@ Accept wildcard characters: False ``` ### -LocalSiteUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the migration source. Can be a local site or a local hubsite. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -136,13 +148,15 @@ Accept wildcard characters: False ``` ### -LocalTermStoreName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the local term store of the local site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -152,13 +166,15 @@ Accept wildcard characters: False ``` ### -RemoteSiteUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the migration target. You can input a remote site url or remote hub site url, both will be processed to be the hub site url. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSideBySideFiles.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSideBySideFiles.md index 8231654a6..ddb93e05c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSideBySideFiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSideBySideFiles.md @@ -27,7 +27,7 @@ In SharePoint Server 2016, zero down time in-place upgrade is available. If the ## EXAMPLES -### Example 1 +### Example 1 ``` Copy-SPSideBySideFiles -LogFile "C:\CopySideBySideFiles.log" ``` @@ -37,6 +37,9 @@ This example copies SideBySide files and writes a log data of the copy process t ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -LogFile + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the fully-qualified logfile name of SideBySide copy operation. If LogFile is not specified, the logfile will be placed in default SharePoint log files folder. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSite.md index 88bc7a1c9..af5cb33db 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPSite.md @@ -17,7 +17,6 @@ ms.reviewer: Makes a copy of a site collection. - ## SYNTAX ``` @@ -37,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------- +### EXAMPLE ``` Copy-SPSite https://contoso/sites/OldTeam -DestinationDatabase WSS_Content -TargetUrl https://contoso/sites/NewTeam ``` @@ -47,14 +46,16 @@ This example makes a copy of the https://contoso/sites/OldTeam site collection f ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection to copy. This can be a valid URL or GUID. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +65,15 @@ Accept wildcard characters: False ``` ### -TargetUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URL that will be used for the destination copy of the site collection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location where the copy will be sent to. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Use when the site collection is a host-named site collection that allows the site to land on the correct web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -PreserveSiteId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the SiteID is to be saved or not. The valid values are True and False. The default value is False. @@ -141,8 +153,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPTaxonomyGroups.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPTaxonomyGroups.md index 18ddebb42..9326dc2cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPTaxonomyGroups.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Copy-SPTaxonomyGroups.md @@ -28,7 +28,7 @@ Use the Copy-SPTaxonomyGroups cmdlet to copy specified Metadata groups from an o ## EXAMPLES -### Example 1 +### Example 1 ``` $credential = Get-Credential Copy-SPTaxonomyGroups -LocalTermStoreName "Managed Metadata Service Application Proxy" -LocalSiteUrl "https://sharepoint" -RemoteSiteUrl "https://contoso.sharepoint.com" -GroupNames "Group1","Group2" -Credential $credential @@ -40,6 +40,8 @@ This example copies two taxonomy groups "Group1" and "Group2" from local Term St ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -AuthEndpoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Azure Active Directory Graph API authentication endpoint. By default, the well-known endpoint will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. Writes data to remote Term Store, so a Term Store Administrator's credential is needed to perform the operations. @@ -85,8 +91,7 @@ Writes data to remote Term Store, so a Term Store Administrator's credential is ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -GraphApiEndpoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Azure Active Directory Graph API endpoint. By default, the well-known endpoint will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -GroupNames + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name array of Taxonomy groups in local on-premises term store that will be copied to remote SharePoint Online Term store. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -LocalSiteUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Url of local SharePoint on-premises site that contains the local Taxonomy Term Store. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -144,13 +155,15 @@ Accept wildcard characters: False ``` ### -LocalTermStoreName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of local Taxonomy Term Store in the SharePoint on-premises farm. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -160,13 +173,15 @@ Accept wildcard characters: False ``` ### -RemoteSiteUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Url of remote SharePoint Online site that contains remote Taxonomy Term Store. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-ProjectServerLicense.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-ProjectServerLicense.md index 8846e0cbf..d1a98f8bd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-ProjectServerLicense.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-ProjectServerLicense.md @@ -26,7 +26,7 @@ Disables Project Server functionality across the farm. ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-ProjectServerLicense ``` @@ -36,6 +36,9 @@ This example disables Project Server functionality for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPAppAutoProvision.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPAppAutoProvision.md index ce23bfeeb..23b5cd9c3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPAppAutoProvision.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPAppAutoProvision.md @@ -17,7 +17,6 @@ ms.reviewer: Disables automatic provisioning of an app. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Disable-SPAppAutoProvision ``` @@ -41,7 +40,7 @@ This example disables app auto provisioning for the farm. The app auto provisioning is enabled by default. This setting overrides site subscription level setting. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` C:\PS>$subscription = Get-SPSiteSubscription https://Contoso.com @@ -54,6 +53,9 @@ The app auto provisioning is enabled by default. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +67,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +77,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for which auto provisioning is to be disabled. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPBusinessDataCatalogEntity.md index a0631dae2..02f39e305 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPBusinessDataCatalogEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPBusinessDataCatalogEntity.md @@ -17,7 +17,6 @@ ms.reviewer: Deactivates an External Content type in the Business Data Connectivity Metadata Store. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$entityToDisable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso Disable-SPBusinessDataCatalogEntity -Identity $entityToDisable @@ -44,13 +43,15 @@ Note that the terms External Content type and Entity refer to the same object ty ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the External Content type in the Business Data Connectivity Metadata Store to deactivate. ```yaml Type: Entity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPFeature.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPFeature.md index 1ba331109..8037d68bf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPFeature.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPFeature.md @@ -17,7 +17,6 @@ ms.reviewer: Disables an installed SharePoint Feature at a given scope. - ## SYNTAX ``` @@ -34,14 +33,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Disable-SPFeature -identity "MyCustom" -URL https://somesite ``` This example disables the "MyCustom" Web site scoped feature at https://somesite. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` C:\PS>$w = Get-SPWeb https://somesite/myweb | ForEach{ $_.URL } Get-SPFeature -Web $w |%{ Disable-SPFeature -Identity $_ -URL $w} @@ -54,6 +53,9 @@ You do not need to use the SPAssignment cmdlets in this case because the Web obj ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Feature or GUID to disable. The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the format 21d186e1-7036-4092-a825-0eb6709e9281. @@ -61,8 +63,7 @@ The type must be the name of the Feature folder located in the 14\Template\Featu ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +87,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -111,13 +116,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces a Feature to be disabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the Web application, site collection, or Web site to which the Feature is being disabled. The type must be a valid URL, such as https://server_name. @@ -134,8 +144,7 @@ The type must be a valid URL, such as https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +164,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPHealthAnalysisRule.md index fde00e77d..933ed67c6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPHealthAnalysisRule.md @@ -17,7 +17,6 @@ ms.reviewer: Disables health analyzer rules. - ## SYNTAX ``` @@ -37,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ``` Disable-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -47,6 +46,9 @@ This example disables the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or GUID of the health analyzer rule to disable. The type must be a valid name; an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -54,8 +56,7 @@ The type must be a valid name; an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPInfoPathFormTemplate.md index eaa46ef12..28cceac32 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPInfoPathFormTemplate.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Disable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site https://testSite ``` @@ -39,6 +39,9 @@ This example deactivates an InfoPath form template from a site collection named ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to disable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection that contains the InfoPath form template to deactivate. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -65,7 +70,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPSitePipeBind Parameter Sets: (All) Aliases: Url -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index 11ded43d6..87955ed4f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -46,7 +46,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync https://localhost/pwa ``` @@ -56,13 +56,15 @@ This example disables Timer Job execution of the Active Directory Enterprise Res ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App (PWA) instance to disable Active Directory Enterprise Resource Sync. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEmailNotification.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEmailNotification.md index 078d50443..eb4521079 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEmailNotification.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEmailNotification.md @@ -27,7 +27,7 @@ Turns off the Project Web App site level setting for email notifications in Proj ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-SPProjectEmailNotification -Url https://pwa_site ``` @@ -37,6 +37,9 @@ Disables Project Server email notifications on the Project Web App site, https:/ ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2016, Project Server 2019 + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEnterpriseProjectTaskSync.md index ea31909fd..e45d0fc20 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectEnterpriseProjectTaskSync.md @@ -27,7 +27,7 @@ Disables task sync between Project Web App and the associated project site. ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-SPProjectEnterpriseProjectTaskSync -Url https://pwa_site ``` @@ -37,6 +37,9 @@ Disables Project Server task sync on the Project Web App site, https://pwa_site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectQueueStatsMonitoring.md index 38a28ab09..2e0f3239b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectQueueStatsMonitoring.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPProjectQueueStatsMonitoring.md @@ -26,7 +26,7 @@ Disables monitoring Project Server queue statistics. ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-SPProjectQueueStatsMonitoring ``` @@ -36,6 +36,9 @@ Disables monitoring Project Server queue statistics. ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSessionStateService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSessionStateService.md index d98017b1f..19942fc0e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSessionStateService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSessionStateService.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Disable-SPSessionStateService ``` @@ -43,6 +43,9 @@ This example turns off ASP.NET session state on the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +57,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -72,7 +77,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSingleSignOn.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSingleSignOn.md index 1be72ab9d..6b71b85ad 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSingleSignOn.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPSingleSignOn.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Disable-SPSingleSignOn myOldSSO -ServerName CONTOSO ``` @@ -39,13 +39,15 @@ This example turns off the SSO Service on the server named CONTOSO. ## PARAMETERS ### -ServerName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the server in which the service is running. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPTimerJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPTimerJob.md index b8f343871..83b32b0ab 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPTimerJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPTimerJob.md @@ -17,7 +17,6 @@ ms.reviewer: Disables a timer job. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ``` Disable-SPTimerJob job-ceip-datacollection ``` @@ -42,6 +41,9 @@ This example disables the timer job named job-ceip-datacollection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the timer job to disable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserLicensing.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserLicensing.md index 15efa35cb..b762e40c7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserLicensing.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserLicensing.md @@ -17,7 +17,6 @@ ms.reviewer: Disables user license enforcement. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ``` Disable-SPUserLicensing ``` @@ -42,6 +41,9 @@ This example disables user license enforcement on the SharePoint farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -71,7 +75,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserSolutionAllowList.md index 8c3a309cf..9cdea5066 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPUserSolutionAllowList.md @@ -27,7 +27,7 @@ Disables the user managed solutions gallery capability on the farm. ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-SPUserSolutionAllowList ``` @@ -37,6 +37,9 @@ Disables the user managed solutions gallery capability on the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,6 +75,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -78,7 +85,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebApplicationHttpThrottling.md index 7123364ac..e640469dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebApplicationHttpThrottling.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebApplicationHttpThrottling.md @@ -17,7 +17,6 @@ ms.reviewer: Turns off network throttling for a Web application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Disable-SPWebApplicationHTTPThrottling https://sitename ``` @@ -43,6 +42,9 @@ This example disables network throttling on the Web application https://sitename ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns off network throttling on the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebTemplateForSiteMaster.md index 645d75ec4..6bab5de4b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebTemplateForSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disable-SPWebTemplateForSiteMaster.md @@ -27,7 +27,7 @@ Use the Disable-SPWebTemplateForSiteMaster cmdlet to disable a site master in th ## EXAMPLES -### Example 1 +### Example 1 ``` Disable-SPWebTemplateForSiteMaster -Template STS#0 ``` @@ -37,6 +37,9 @@ This example disables the template in the site master of a farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -62,8 +67,7 @@ When this parameter is not specified, the CompatibilityLevel parameter will defa ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the template. For example, SPSPERS#2. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disconnect-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disconnect-SPConfigurationDatabase.md index 801bdefe9..ec6a7eabd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disconnect-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Disconnect-SPConfigurationDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Disconnects the local server computer from the farm. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Disconnect-SPConfigurationDatabase -Confirm:$false ``` @@ -44,6 +43,9 @@ This example removes the local server computer from a farm without prompting for ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +57,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -73,7 +77,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPContentDatabase.md index 05a861bd4..241a91e84 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPContentDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Detaches a content database from its currently associated Web application. - ## SYNTAX ``` @@ -34,14 +33,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ``` Dismount-SPContentDatabase 12345678-90ab-cdef-1234-567890abcdef ``` This example detaches the content database with the GUID 12345678-90ab-cdef-1234-567890abcdef from its current parent Web application. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ``` Get-SPContentDatabase -WebApplication https://sitename | Dismount-SPContentDatabase -WhatIf ``` @@ -52,6 +51,9 @@ Remove the WhatIf parameter to perform the operation. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database to detach. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -59,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +105,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPSiteMapDatabase.md index 045e04a68..59da8750f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPSiteMapDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPSiteMapDatabase.md @@ -27,7 +27,7 @@ Do not use. ## EXAMPLES -### ------------EXAMPLE------------------ +### EXAMPLE ``` ``` @@ -37,13 +37,15 @@ Do not use. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016 Required: False Position: Named @@ -69,13 +73,15 @@ Accept wildcard characters: False ``` ### -DatabaseId + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 0 @@ -85,13 +91,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPStateServiceDatabase.md index 2e409afca..34165324c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Dismount-SPStateServiceDatabase.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Dismount-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example removes the association between the SharePoint farm and the SQL Server database without dropping the SQL Server database. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPStateServiceDatabase -ServiceApplication F9168C5E-CEB2-4faa-B6B F-329BF39FA1E4 | Dismount-SPStateServiceDatabase @@ -48,6 +48,9 @@ This example dismounts a single database because only the Identity parameter is ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to remove from the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -56,7 +59,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +102,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-ProjectServerLicense.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-ProjectServerLicense.md index 1ea16d717..5a62791bd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-ProjectServerLicense.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-ProjectServerLicense.md @@ -27,7 +27,7 @@ Enables Project Server functionality on the farm. ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-ProjectServerLicense -Key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX ``` @@ -37,6 +37,9 @@ This example enables all Project Server functionality in the farm. The type of l ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Key + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + License key (trial or full). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPAppAutoProvision.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPAppAutoProvision.md index faa5f7f44..62cd1f875 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPAppAutoProvision.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPAppAutoProvision.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1-------- +### EXAMPLE 1 ``` Enable-SPAppAutoProvision ``` @@ -39,7 +39,7 @@ This example enables auto provisioning for the farm. The app auto provisioning is enabled by default. This setting overrides site subscription level setting. -### --------------EXAMPLE 2-------- +### EXAMPLE 2 ``` C:\PS>$subscription = Get-SPSiteSubscription https://Contoso.com Enable-SPAppAutoProvision -SiteSubscription $subscription @@ -51,6 +51,9 @@ The app auto provisioning is enabled by default. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -62,8 +65,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for which auto provisioning is to be enabled. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPBusinessDataCatalogEntity.md index 0fb650c0e..993032500 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPBusinessDataCatalogEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPBusinessDataCatalogEntity.md @@ -17,7 +17,6 @@ ms.reviewer: Activates an External Content type in the Business Data Connectivity Metadata Store. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$entityToEnable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso Enable-SPBusinessDataCatalogEntity -Identity $entityToEnable @@ -44,13 +43,15 @@ Note that the terms External Content type and Entity refer to the same object ty ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the External Content type in the Business Data Connectivity Metadata Store to activate. ```yaml Type: Entity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPFeature.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPFeature.md index 022d60595..fa9c1099e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPFeature.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPFeature.md @@ -31,7 +31,7 @@ Enable-SPFeature [-Identity] [-AssignmentCollectio ``` ## DESCRIPTION -The Enable-SPFeature cmdlet enables an installed feature at the given scope. +The Enable-SPFeature cmdlet enables an installed feature at the given scope. If the feature is a farm feature, no URL is needed. Otherwise, provide the URL where the feature is to be enabled and it will be enabled at the proper scope based on the Feature definition. @@ -45,14 +45,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Enable-SPFeature -identity "MyCustom" -URL https://somesite ``` This example enables the "MyCustom" site scoped SharePoint Feature at https://somesite. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` C:\PS>$w = Get-SPWeb https://somesite/myweb | ForEach{ $_.URL } Get-SPFeature -Web $w |%{ Enable-SPFeature -Identity $_ -URL $w} @@ -63,6 +63,9 @@ This example enables all SharePoint Features in the subsite at https://somesite/ ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Feature or GUID to uninstall. The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. @@ -70,8 +73,7 @@ The type must be the name of the Feature folder located in the 14\Template\Featu ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -120,6 +126,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the activation of a Feature. This causes any custom code associated with the Feature to rerun. @@ -129,8 +138,7 @@ This causes any custom code associated with the Feature to rerun. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +148,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If provided, the cmdlet outputs the Feature definition object after enable. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +166,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the Web application, site collection, or Web site for which the Feature is being activated. The type must be a valid URL; for example, https://server_name. @@ -163,8 +176,7 @@ The type must be a valid URL; for example, https://server_name. ```yaml Type: String Parameter Sets: SiteFeature -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +186,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -181,7 +196,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -191,13 +205,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill CompatibilityLevel Description}} ```yaml Type: Int32 Parameter Sets: FarmFeatureDefinition -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPHealthAnalysisRule.md index 9765d94cf..e35a42da4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPHealthAnalysisRule.md @@ -17,7 +17,6 @@ ms.reviewer: Enables a health analyzer rule. - ## SYNTAX ``` @@ -37,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ``` Enable-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -47,6 +46,9 @@ This example enables the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or GUID of the health analyzer rule to enable. The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -54,8 +56,7 @@ The type must be a valid name, an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPInfoPathFormTemplate.md index 7d0613a4b..71b30c3e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPInfoPathFormTemplate.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Enable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site "https://TestSite" ``` @@ -40,6 +40,9 @@ This example activates an InfoPath form template to a site collection named Test ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to activate. The form template must be an administrator-approved, browser-enabled form template that is available on the server farm. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection that contains the InfoPath form template to activate. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -67,7 +72,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPSitePipeBind Parameter Sets: (All) Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index 5a662ecfc..cd98dda6e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -59,13 +59,15 @@ Retrieves the ObjectGuid values of the Domain Users and Domain Admins Active Dir ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance to enable Active Directory Enterprise Resource Sync. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -75,13 +77,15 @@ Accept wildcard characters: False ``` ### -GroupUids + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Active Directory Group GUID to synchronize the Enterprise Resource Pool with. ```yaml Type: System.Collections.Generic.IEnumerable`1[System.Guid] Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEmailNotification.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEmailNotification.md index c62c2720c..cbc6b0726 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEmailNotification.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEmailNotification.md @@ -27,7 +27,7 @@ Turns on the Project Web App site level setting for email notifications in Proje ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-SPProjectEmailNotification -Url https://pwa_site ``` @@ -37,6 +37,9 @@ Enables Project Server email notifications on the Project Web App site, https:// ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ NOTE: When the Global parameter is used, all objects are contained in the global ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,12 +57,14 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEnterpriseProjectTaskSync.md index d32abd83a..3093c0991 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectEnterpriseProjectTaskSync.md @@ -31,7 +31,7 @@ Enables task sync between Project Web App and the associated project site. ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-SPProjectEnterpriseProjectTaskSync -Url https://pwa_site ``` @@ -41,6 +41,9 @@ Enables Project Task sync on the Project Web Apps site, https://pwa_site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectQueueStatsMonitoring.md index 4f590e33e..a1ade8f3f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectQueueStatsMonitoring.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPProjectQueueStatsMonitoring.md @@ -26,7 +26,7 @@ Enables monitoring Project Server queue statistics. ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-SPProjectQueueStatsMonitoring ``` @@ -36,6 +36,9 @@ Enables monitoring Project Server queue statistics. ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPSessionStateService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPSessionStateService.md index 3f65631cf..612916250 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPSessionStateService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPSessionStateService.md @@ -41,14 +41,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Enable-SPSessionStateService -DefaultProvision ``` This example enables a ASP.NET session state on a SharePoint Server farm that uses the defaults (database hosted on the configuration database SQL Server, using Windows authentication, 60-minute session time-out). -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Enable-SPSessionStateService -DatabaseName "Session State Database" -DatabaseServer "localhost" -SessionTimeout 120 ``` @@ -58,6 +58,9 @@ This example enables a ASP.NET session state on a SharePoint Server farm that us ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database for the session state service. The type must be a valid name of a SQL Server database; for example, SessionStateDB1. @@ -65,8 +68,7 @@ The type must be a valid name of a SQL Server database; for example, SessionStat ```yaml Type: String Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,14 +78,16 @@ Accept wildcard characters: False ``` ### -DefaultProvision + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the default provisioning settings are used. The default provisioning settings are: Windows Authentication, Auto SQL Server (configuration database), and Auto Catalog Name. ```yaml Type: SwitchParameter Parameter Sets: DefaultProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +111,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database credentials for SQL Authentication used to access the session state service database. If this parameter is not specified, Windows authentication is used. @@ -140,8 +151,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +161,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the host SQL Server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -158,8 +171,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,14 +181,16 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in minutes, that a ASP .NET session state service will remain active with no user activity. The default value is 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +200,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -193,7 +210,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPTimerJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPTimerJob.md index a86c223d7..0152ce16b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPTimerJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPTimerJob.md @@ -17,7 +17,6 @@ ms.reviewer: Enables a timer job. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ``` Get-SPTimerJob job-ceip-datacollection | Enable-SPTimerJob ``` @@ -43,6 +42,9 @@ This example enables the timer job named job-ceip-datacollection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the timer job to enable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserLicensing.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserLicensing.md index 85a1c80d9..0da394db9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserLicensing.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserLicensing.md @@ -17,7 +17,6 @@ ms.reviewer: Enables user-license enforcement. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ``` Enable-SPUserLicensing ``` @@ -42,6 +41,9 @@ This example enables user-license enforcement on the SharePoint farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -71,7 +75,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserSolutionAllowList.md index a3545ef31..e09619d8c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPUserSolutionAllowList.md @@ -27,7 +27,7 @@ Enables the user managed solutions gallery capability on the farm. ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-SPUserSolutionAllowList ``` @@ -37,6 +37,9 @@ This example enables a user managed solutions gallery on the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,6 +75,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -78,7 +85,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebApplicationHttpThrottling.md index a37850fa3..489e8a45a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebApplicationHttpThrottling.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebApplicationHttpThrottling.md @@ -17,7 +17,6 @@ ms.reviewer: Turns on network throttling for a Web application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Enable-SPWebApplicationHttpThrottling https://sitename ``` @@ -43,6 +42,9 @@ This example enables network throttling on the https://sitename Web application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on network throttling on the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebTemplateForSiteMaster.md index 3c937c323..e781934a9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebTemplateForSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Enable-SPWebTemplateForSiteMaster.md @@ -27,7 +27,7 @@ Use the Enable-SPWebTemplateEnabledForSiteMaster cmdlet to create a site master ## EXAMPLES -### Example 1 +### Example 1 ``` Enable-SPWebTemplateForSiteMaster -Template STS#0 -CompatibilityLevel 15 ``` @@ -37,6 +37,9 @@ This example creates a site master in the database using the Team Site template. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -62,8 +67,7 @@ When this parameter is not specified, the CompatibilityLevel parameter will defa ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the template. For example, SPSPERS#2. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAccessServicesDatabase.md index b3ee9dfc9..43ba0e795 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAccessServicesDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAccessServicesDatabase.md @@ -33,7 +33,7 @@ See more information about Data-Tier Framework at [Data-tier Applications](https ## EXAMPLES -### Example 1 +### Example 1 ``` $contentdb = Get-SPContentDatabase ContentDbName $accessDb = Get-SPAccessServicesDatabase -ContentDb $contentdb -EA 0 | Select -First 1 @@ -45,6 +45,9 @@ This cmdlet retrieves the first Access Database from the specified Content Datab ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -52,8 +55,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The name of the Access Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -ServerReferenceId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The ServerReferenceId used for the Access Database. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAppPackage.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAppPackage.md index 47e6b9e46..3412f6b7e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAppPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPAppPackage.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------- +### EXAMPLE ``` C:\PS>$instance = Get-SPAppInstance -AppInstanceId $instance.Id Export-SPAppPackage -App $instance.App -Path .\exported.spapp @@ -41,13 +41,15 @@ This example exports an app package to the \exported.spapp location. ## PARAMETERS ### -App + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the App for which to export the package. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of the exported file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPBusinessDataCatalogModel.md index 422d4fcd0..b4527caa6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPBusinessDataCatalogModel.md @@ -17,7 +17,6 @@ ms.reviewer: Exports a Business Data Connectivity Model. - ## SYNTAX ``` @@ -27,7 +26,7 @@ Export-SPBusinessDataCatalogModel -Identity -Path ``` ## DESCRIPTION -The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. +The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). The Model type contains the base XML metadata, and can also include resource properties. The Resource type includes only resource properties. @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceContext http://contoso Export-SPBusinessDataCatalogModel -Identity $Model -Path "C:\folder\model.bdcm" @@ -47,13 +46,15 @@ This example gets a Business Data Connectivity Model from the Business Data Conn ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object from which to export the Business Data Connectivity Model. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name to use to create the export file. The type must be a valid path in either of the following forms: @@ -74,8 +78,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the output file if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that names for business data fields in multiple languages are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +148,16 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that models are included in the exported Business Data Connectivity Model file. A model contains the base XML metadata for a system. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +167,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that permissions from the Business Data Connectivity Model are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that properties from the application definition are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that proxies for Business Data Connectivity Service applications are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +221,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom environment settings model slice to export. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -211,8 +231,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPEnterpriseSearchTopology.md index 603d5a4f7..495445a29 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPEnterpriseSearchTopology.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication Export-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename topology.xml @@ -40,6 +40,9 @@ This example exports the topology to a file named topology.xml in the search ser ## PARAMETERS ### -Filename + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and file name to use to create the topology XML file. The type must be a valid path, in the form MyFeature\Feature.xml. @@ -47,8 +50,7 @@ The type must be a valid path, in the form MyFeature\Feature.xml. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application with the topology to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPInfoPathAdministrationFiles.md index 990dcd1ca..b26f92292 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPInfoPathAdministrationFiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPInfoPathAdministrationFiles.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Export-SPInfoPathAdministrationFiles -path d:\file.cab ``` @@ -41,6 +41,9 @@ This example saves all InfoPath form templates (.xsn files) and universal data c ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location and name of the output .cab file. The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. @@ -48,8 +51,7 @@ The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection that contains the InfoPath form template and Central Administration .udcx files to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -105,8 +114,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPMetadataWebServicePartitionData.md index 67c164c4d..6af2824e3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPMetadataWebServicePartitionData.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE-------------- +### EXAMPLE ``` Export-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -Path "\\server_name\folder_name\file_name.cab" ``` @@ -40,6 +40,9 @@ This example creates a backup of data for a specific site subscription on a Meta ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and file name for the file to create from the exported data. The type must be a valid path in either of the following forms: @@ -86,8 +93,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +127,15 @@ Accept wildcard characters: False ``` ### -NoCompression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to not compress the data. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPPerformancePointContent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPPerformancePointContent.md index 7087e2d47..ba923f9ee 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPPerformancePointContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPPerformancePointContent.md @@ -27,7 +27,7 @@ The Export-SPPerformancePointContent exports a PPS dashboard and its dependencie ## EXAMPLES -### Example 1 +### Example 1 ``` Export-SPPerformancePointContent -ItemUrls https://contoso/sites/marketing/default.aspx -ExportFileURL "https://contoso/bicenter/SharedDocuments/bi/dashboard1.cmp" ``` @@ -37,6 +37,9 @@ This example exports a dashboard at the location specified with the ItemUrls par ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -ExportFileUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Output name and path of the CMP file to which the data will be stored. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -ItemUrls + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URL to the dashboard to be migrated or to the additional content URLs. ```yaml Type: Array Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPScaleOutDatabaseTenantData.md index 2e656a6f7..49bd4ad85 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPScaleOutDatabaseTenantData.md @@ -17,7 +17,6 @@ ms.reviewer: Exports the data of the specified subscription. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE------- +### EXAMPLE ``` Export-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -43,13 +42,15 @@ This example exports data for the site subscription with id 5CAF2F99-A75F-4239-B ## PARAMETERS ### -FilePath + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the output path for the file to export the data to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to export the data from. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,13 +78,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription id of the site subscription to export the data from. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites an existing data file without prompting for confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPServerScaleOutDatabaseTenantData.md index 9742c1802..3a8253e1f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPServerScaleOutDatabaseTenantData.md @@ -28,10 +28,9 @@ Export-SPServerScaleOutDatabaseTenantData [-AssignmentCollection Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill FilePath Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill ServiceApplication Description}} ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill SiteSubscriptionId Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -144,7 +158,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md index 4d4d86a6c..f18e4b439 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Exports all data from the Business Data Connectivity Metadata Store associated with a partition. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Export-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -Path "C:\folder\exportedFile.xml" ``` @@ -44,6 +43,9 @@ This example exports the data file named exportedFile.xml. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name to use to create the export file. The type must be a valid path in either of the following forms: @@ -55,8 +57,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context of the data to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -73,8 +77,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +101,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,13 +130,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the output file if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,13 +148,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that names for business data fields in multiple languages are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that Business Data Connectivity models are included in the exported file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,13 +184,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that permissions from the Business Data Connectivity Models are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +202,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that properties from the Business Data Connectivity Models are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +220,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that proxies for Business Data Connectivity Service applications are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +238,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -226,7 +248,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionSettings.md index b77cfa5ff..6d71c0904 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPSiteSubscriptionSettings.md @@ -17,7 +17,6 @@ ms.reviewer: Creates a backup file of site subscription data. - ## SYNTAX ``` @@ -32,15 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Export-SPSiteSubscriptionSettings -Identity "https://siteCollection" -Path "C:\siteCollection_sitesubscriptionsettings.txt" ``` The example backs up the subscription settings store of https://siteCollection. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` C:\PS>$site = Get-SPSite https://siteCollection Export-SPSiteSubscriptionSettings -Identity $site.SiteSubscription -Path "C:\siteCollection_sitesubscriptionsettings.txt" @@ -51,6 +49,9 @@ The example backs up the subscription settings store of https://siteCollection u ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the site subscription from which to back up data. The type must be a valid URL, in the form https://server_name or a Site Subscription object. @@ -58,8 +59,7 @@ The type must be a valid URL, in the form https://server_name or a Site Subscrip ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +69,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location of the output file. The type must be a valid path; for example, C:/backupfile.back.. @@ -76,8 +79,7 @@ The type must be a valid path; for example, C:/backupfile.back.. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,14 +89,16 @@ Accept wildcard characters: False ``` ### -AdminProperties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only administrator subscription properties are exported. If this parameter is not set, only non-administrator subscription properties are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +108,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -115,8 +122,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +132,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the output backup file (if provided) to overwrite any existing file at the given path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPTagsAndNotesData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPTagsAndNotesData.md index c00f7f53f..98896758b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPTagsAndNotesData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPTagsAndNotesData.md @@ -28,7 +28,7 @@ The tags and notes are written into separate files, and then the two are compres ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ``` Export-SPTagsAndNotesData -Site https://site.contoso.com -FilePath C:\TagsAndNotes.zip ``` @@ -38,6 +38,9 @@ This example creates a new ZIP file called TagsAndNotes.zip, on the root of C: d ## PARAMETERS ### -Site + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + URL of the root site where you want to export the tags and notes from. You must specify a valid URL to an existing SharePoint root site. @@ -46,8 +49,7 @@ For example: https://site.contoso.com ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + File name, including full path, that you want export the tags and notes to. The cmdlet will create a new ZIP file with the name you specified. @@ -65,8 +70,7 @@ If the file already exists, the cmdlet won't perform the export and will ask you ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -76,13 +80,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPWeb.md index 0f165963a..101179fb5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Export-SPWeb.md @@ -17,7 +17,6 @@ ms.reviewer: Exports a site, list, or library. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE-----------------------. +### EXAMPLE. ``` Export-SPWeb https://site -Path "C:\Temp\export.cmp" ``` @@ -45,6 +44,9 @@ This example exports the site at https://site/ to a file called site export.cmp ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the Web to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint site (for example, MySPSite1); or an instance of a valid SPWeb object. @@ -52,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the export file. If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. @@ -70,8 +74,7 @@ If the NoFileCompression parameter is used, a directory must be specified; other ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,11 +84,13 @@ Accept wildcard characters: False ``` ### -AppLogFilePath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +124,16 @@ Accept wildcard characters: False ``` ### -CompressionSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum file size for the compressed export files. If the total size of the exported package is greater than this size, the exported package will be split into multiple files. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forcefully overwrites the export package if it already exists. The type must be either of the following values: @@ -164,8 +178,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -HaltOnError + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Stops the export process when an error occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -HaltOnWarning + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Stops the export process when a warning occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -208,13 +225,14 @@ Accept wildcard characters: False ### -IncludeUserSecurity +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Preserves the user security settings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +242,9 @@ Accept wildcard characters: False ``` ### -IncludeVersions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates the type of file and list item version history to be included in the export operation. If the IncludeVersions parameter is absent, the Export-SPWeb cmdlet by default uses a value of 1. @@ -244,8 +265,7 @@ All, CurrentVersion, LastMajor, LastMajorAndMinor ```yaml Type: SPIncludeVersions Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -255,6 +275,9 @@ Accept wildcard characters: False ``` ### -ItemUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the Web application, GUID, or object to be exported. The type must be a valid URL; for example, https://server_name. @@ -262,8 +285,7 @@ The type must be a valid URL; for example, https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,6 +295,9 @@ Accept wildcard characters: False ``` ### -NoFileCompression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Either enables or disables file compression in the export package. The export package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. @@ -281,8 +306,7 @@ If compression is enabled, the export process can increase by approximately 30 p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +316,9 @@ Accept wildcard characters: False ``` ### -NoLogFile + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses the generation of an export log file. If this parameter is not specified, the Export-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS). @@ -302,8 +329,7 @@ However, for performance reasons, you might not want to generate a log file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -313,14 +339,16 @@ Accept wildcard characters: False ``` ### -UseSqlSnapshot + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a SQL Database Snapshot will be created when the export process begins, and all exported data will be retrieved directly from the database snapshot. This snapshot will be automatically deleted when export completes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -330,6 +358,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -337,7 +368,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -347,13 +377,15 @@ Accept wildcard characters: False ``` ### -IncludeAlerts + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Indicates if alerts are turned on. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-AvailabilityGroupStatus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-AvailabilityGroupStatus.md index a74d2be29..2b5c8fa35 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-AvailabilityGroupStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-AvailabilityGroupStatus.md @@ -27,9 +27,9 @@ Returns one or more objects representing the availability groups known to the Sh ## EXAMPLES -### Example 1 +### Example 1 ``` -Get-AvailabilityGroupStatus -Identity MyAvailabilityGroup +Get-AvailabilityGroupStatus -Identity MyAvailabilityGroup ``` @@ -38,15 +38,17 @@ This example returns an availability group named "MyAvailabilityGroup". ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Finds the availability group whose name property matches this string. Otherwise, returns all availability groups. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchContentCollection.md index 8a549f8bd..79baaa90d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchContentCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchContentCollection.md @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchContentCollection ``` This example retrieves all FAST Search Server 2010 for SharePoint content collections. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchContentCollection -Name newscollection ``` @@ -46,13 +46,15 @@ This example retrieves the "newscollection" content collection. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the FAST Search Server 2010 for SharePoint collection to retrieve. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchDocumentProcessingPipeline.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchDocumentProcessingPipeline.md index 9b939bf25..b2872d406 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchDocumentProcessingPipeline.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchDocumentProcessingPipeline.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchDocumentProcessingPipeline ``` This example retrieves all FAST Search Server 2010 for SharePoint document processing pipelines. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchDocumentProcessingPipeline -Name "Office14 (webcluster)" ``` @@ -48,13 +48,15 @@ This example retrieves a single FAST Search Server 2010 for SharePoint document ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the document processing pipeline to retrieve. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCategory.md index 45438eb9d..e3b044b4a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCategory.md @@ -31,7 +31,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchMetadataCategory ``` @@ -39,14 +39,14 @@ Get-FASTSearchMetadataCategory This example returns all available categories. This is the default behavior if you do not specify any parameters. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchMetadataCategory -Name SharePoint ``` This example returns one specific category, the "SharePoint" category. -### ---------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Get-FASTSearchMetadataCategory -Name m* ``` @@ -54,7 +54,7 @@ Get-FASTSearchMetadataCategory -Name m* This example returns all categories with a name that begins with "m". Matching is case-insensitive. -### ---------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` $category = Get-FASTSearchMetadataCategory -Name "Enterprise Crawler" $category.GetAllCrawledProperties()|ForEach-Object {$_.Name} @@ -67,6 +67,9 @@ It then iterates over the list of crawled properties and selects the name of eac ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the category to retrieve. If no category is specified, all categories are returned. @@ -74,7 +77,6 @@ If no category is specified, all categories are returned. Type: String Parameter Sets: (All) Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledProperty.md index 9770c55c0..ca84fa496 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledProperty.md @@ -44,35 +44,35 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchMetadataCrawledProperty ``` Calling Get-FASTSearchMetadataCrawledProperty without any parameters returns all known crawled properties in the FAST Search Server 2010 for SharePoint system. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchMetadataCrawledProperty -Name viewurl ``` This example retrieves a crawled property with the exact name "viewurl". -### ---------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Get-FASTSearchMetadataCrawledProperty -filter 4 ``` This example retrieves and returns any crawled property that includes a "4" in its name. -### ---------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Get-FASTSearchMetadataCrawledproperty -filter url -count 2 ``` This example retrieves the first two crawled properties with the name "url". -### ---------------EXAMPLE 5----------------- +### EXAMPLE 5 ``` Get-FASTSearchMetadataCrawledproperty |ForEach-Object{ if ($_.IsMappedToContents) {$_.Name} } ``` @@ -80,7 +80,7 @@ Get-FASTSearchMetadataCrawledproperty |ForEach-Object{ if ($_.IsMappedToContents This example returns the names of all crawled properties that have the IsMappedToContents parameter set to "true". The example first retrieves all configured crawled properties, and then iterates over them to find those with IsMappedToContents set to "true" -### ---------------EXAMPLE 6----------------- +### EXAMPLE 6 ``` Get-FASTSearchMetadataCrawledproperty -offset 0 -count 2 Get-FASTSearchMetadataCrawledproperty -offset 2 -count 2 @@ -90,7 +90,7 @@ Get-FASTSearchMetadataCrawledproperty -offset 4 -count 2 This example generates a list of two crawled properties each time the cmdlet is run. The Offset is increased by the Count value to start returning crawled properties where the last run ended. -### ---------------EXAMPLE 7----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 7 (FAST Server for SharePoint 2010) ``` Get-FASTSearchMetadataCrawledProperty -filter url| where-object {($_.Name -eq "url") -and ($_.VariantType -eq 31) -and ($_.Propset -eq "63e90878-0292-490d-8b7c-f3905a8b65fd")} ``` @@ -101,6 +101,9 @@ The command returns the "url" crawled property in the "Enterprise Crawler" categ ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of crawled property to retrieve. The Name parameter supports wildcards. @@ -109,8 +112,7 @@ Combine the Name parameter with the Offset and Count parameters to control the r ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -120,6 +122,9 @@ Accept wildcard characters: False ``` ### -Count + +> Applicable: FAST Server for SharePoint 2010 + The maximum number of crawled properties to return (starting from the first returned crawled property, or from the index given by the Offset parameter). If the Filter or Name parameter is specified, these will only be applied after the result set has been narrowed down to the range \[Offset, Offset + Count\]. @@ -127,8 +132,7 @@ If the Filter or Name parameter is specified, these will only be applied after t ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -138,6 +142,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: FAST Server for SharePoint 2010 + The term used to search for configured crawled properties. The Filter parameter does not support wildcards. @@ -146,8 +153,7 @@ Matching is case-insensitive, and matches a string anywhere within the name attr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -157,13 +163,15 @@ Accept wildcard characters: False ``` ### -Offset + +> Applicable: FAST Server for SharePoint 2010 + The offset in the result set from which to start returning results. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledPropertyMapping.md index 36cc57b87..7f62345fa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledPropertyMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataCrawledPropertyMapping.md @@ -35,14 +35,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` C:\PS>Get-FASTSearchMetadataCrawledPropertyMapping -Name title ``` This example returns a list of crawled properties that are mapped to the managed property named "title". -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` $managedproperty = Get-FASTSearchMetadataManagedProperty -name title Get-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $managedproperty @@ -51,7 +51,7 @@ Get-FASTSearchMetadataCrawledPropertyMapping -ManagedProperty $managedproperty This example first retrieves a ManagedPropertyImpl object, and then uses it to look up the corresponding crawled property mappings. It returns all crawled properties that are set up to map content into this managed property. -### ---------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` $crawledproperty = Get-FASTSearchmetadataCrawledProperty -name title $crawledproperty.GetMappedManagedProperties() @@ -63,13 +63,15 @@ This is useful when assessing how modifying a crawled property will impact the s ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of a managed property for finding crawled properties. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -79,13 +81,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property object for finding crawled properties. ```yaml Type: ManagedProperty Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndex.md index dd35b5329..22a135a06 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndex.md @@ -32,7 +32,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchMetadataFullTextIndex -Name content ``` @@ -42,13 +42,15 @@ This example retrieves the full text index named "content". ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the full text index to retrieve. ```yaml Type: String Parameter Sets: (All) Aliases: FullTextIndexName, N -Applicable: FAST Server for SharePoint 2010 Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndexMapping.md index 24e1ebcbd..4b520ba3c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndexMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataFullTextIndexMapping.md @@ -36,7 +36,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` $fulltextindex = Get-FASTSearchMetadataFullTextIndex -name content Get-FASTSearchMetadataFullTextIndexMapping -fulltextindex $fulltextindex| ForEach-Object {$_.ManagedProperty.Name} @@ -45,7 +45,7 @@ Get-FASTSearchMetadataFullTextIndexMapping -fulltextindex $fulltextindex| ForEac This example retrieves the full text index mappings for the full text index "content". It then iterates over the mappings and outputs the names of the managed properties included in the full text index. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` $title = Get-FASTSearchMetadataManagedProperty -name title Get-FASTSearchMetadataFullTextIndexMapping -managedproperty $title @@ -58,13 +58,15 @@ The specified managed property is mapped to both "content" and "thirdfulltextind ## PARAMETERS ### -FullTextIndex + +> Applicable: FAST Server for SharePoint 2010 + The full text index specified to retrieve mappings. ```yaml Type: FullTextIndex Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property specified to retrieve mappings. ```yaml Type: ManagedProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataManagedProperty.md index 3b8a516a1..e9b08d3e0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataManagedProperty.md @@ -33,7 +33,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchMetadataManagedProperty -name title ``` @@ -41,7 +41,7 @@ Get-FASTSearchMetadataManagedProperty -name title This example retrieves a managed property named "title". It returns an object representing the managed property. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchMetadataManagedProperty -name content* ``` @@ -52,6 +52,9 @@ It returns a list of managed property objects. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the managed property to retrieve. This option supports wildcards, and the matching is case-insensitive. @@ -59,7 +62,6 @@ This option supports wildcards, and the matching is case-insensitive. Type: String Parameter Sets: (All) Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataRankProfile.md index 17a4f2600..bf90bf800 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataRankProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchMetadataRankProfile.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchMetadataRankProfile -Name newdefault ``` This example retrieves the rank profile named "newdefault". -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchMetadataRankProfile -Name *?default ``` @@ -49,6 +49,9 @@ It will not match the default rankprofile named "default". ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the rank profile to retrieve. This option supports wildcards, and matching is case-insensitive. @@ -56,7 +59,6 @@ This option supports wildcards, and matching is case-insensitive. Type: String Parameter Sets: (All) Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchResource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchResource.md index 21692d184..9cffa82bb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchResource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchResource.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchResource dictionaries\spellcheck\check_en.aut c:\check_en.aut ``` @@ -39,13 +39,15 @@ This example downloads dictionaries\spellcheck\check_en.aut from the resource st ## PARAMETERS ### -Path + +> Applicable: FAST Server for SharePoint 2010 + Partial URI within the resource store where the file needs to be downloaded from. ```yaml Type: String Parameter Sets: (All) Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: FAST Server for SharePoint 2010 + Path to download the resource. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSearchSettingGroup.md index f2870d5e1..024691c84 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSearchSettingGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSearchSettingGroup.md @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSearchSettingGroup ``` This example retrieves all FAST Search Server 2010 for SharePoint search setting groups. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSearchSettingGroup -Name marketinggroup ``` @@ -46,13 +46,15 @@ This example retrieves the "marketinggroup" search setting group. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the search setting group to retrieve. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityAliaser.md index aa3939f0c..99ae8b3cf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityAliaser.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityAliaser ``` This example gets a list of all XML and regular expression principal aliasers. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityAliaser -Identity xmlalias4 ``` @@ -48,6 +48,9 @@ This example gets the principal aliaser with the ID "xmlalias4". ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of a regular expression or XML aliaser to get. If not specified, the cmdlet gets a list of all aliasers. @@ -55,8 +58,7 @@ If not specified, the cmdlet gets a list of all aliasers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCCTKServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCCTKServer.md index 860de97e5..32b824c9f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCCTKServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCCTKServer.md @@ -28,7 +28,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityCCTKServer ``` diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityClaimsUserStore.md index 003b8f1fd..904319b19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityClaimsUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityClaimsUserStore.md @@ -30,7 +30,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityClaimsUserStore -Identity clm ``` @@ -40,6 +40,9 @@ This example retrieves the claims user store with the identity "clm". ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of a claims user store to display. If an Identity is not specified, all claims user stores are displayed. @@ -47,8 +50,7 @@ If an Identity is not specified, all claims user stores are displayed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCompleteGroupExpansion.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCompleteGroupExpansion.md index 7452fd5c0..51cd537e2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCompleteGroupExpansion.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityCompleteGroupExpansion.md @@ -33,7 +33,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityCompleteGroupExpansion -Identity ln1 -User user1 ``` @@ -43,13 +43,15 @@ This example retrieves complete group expansion information for "user1" in the u ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store containing the user to expand. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: FAST Server for SharePoint 2010 + The user or group identifier to expand. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -ExtraProperties + +> Applicable: FAST Server for SharePoint 2010 + If specified, the command gets the extra properties for all principals (user and groups) returned by the resolve. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 @@ -91,14 +97,16 @@ Accept wildcard characters: False ``` ### -XmlFile + +> Applicable: FAST Server for SharePoint 2010 + The absolute path to an XML file which is accessible and writable from the security manager. If specified, complete expansion information is written as XML to this file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 @@ -108,13 +116,15 @@ Accept wildcard characters: False ``` ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDecodedSid.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDecodedSid.md index d172c031a..231053d2d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDecodedSid.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDecodedSid.md @@ -28,7 +28,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityDecodedSid -EncodedSID aebaaaaaaaaakiaaaaaccaqaaa ``` @@ -38,13 +38,15 @@ This example retrieves the Windows SID and user or group identifier for an encod ## PARAMETERS ### -EncodedSID + +> Applicable: FAST Server for SharePoint 2010 + The encoded extended security identifier that will be decoded. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDefaultUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDefaultUserStore.md index 30d338f5e..6ad49d46a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDefaultUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityDefaultUserStore.md @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityDefaultUserStore ``` This example gets the identity of the default user store. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityDefaultUserStore ``` @@ -46,13 +46,15 @@ This example gets the default user store's general setting information for the s ## PARAMETERS ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityEncodedSid.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityEncodedSid.md index 685a02ddc..e9d1a604e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityEncodedSid.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityEncodedSid.md @@ -28,14 +28,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityEncodedSid -SID S-1-5-7 ``` This example returns an encoded security identifier and user name for the Windows SID, "5-1-5-7". -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityEncodedSid -User users ``` @@ -45,13 +45,15 @@ This example returns the encoded security identifier for the Windows built-in "U ## PARAMETERS ### -SID + +> Applicable: FAST Server for SharePoint 2010 + The Windows security identifier to encode. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -61,13 +63,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: FAST Server for SharePoint 2010 + The user or group identifier to encode. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityGeneralSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityGeneralSettings.md index a1dcd4f34..52931613a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityGeneralSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityGeneralSettings.md @@ -40,7 +40,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityGeneralSettings | fl ``` @@ -50,13 +50,15 @@ This example retrieves the configuration setting for all the general security se ## PARAMETERS ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLogLevel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLogLevel.md index 964b75ff9..e9391622c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLogLevel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLogLevel.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityLogLevel ``` @@ -39,13 +39,15 @@ This example gets the configuration information for the log level's general sett ## PARAMETERS ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLotusNotesUserStore.md index 187367f42..e8c46e644 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLotusNotesUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityLotusNotesUserStore.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityLotusNotesUserStore -Identity ln1 ``` @@ -39,14 +39,16 @@ This example gets the Lotus Notes user store with the identity "ln1". ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the Lotus Notes user store to get. If not specified, a list of all Lotus Notes user stores is returned. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityPublicFilter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityPublicFilter.md index dd444e2b8..13dfcd314 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityPublicFilter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityPublicFilter.md @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityPublicFilter ``` This example gets the security public filter's general setting configuration information. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityPublicFilter ``` @@ -46,13 +46,15 @@ This example gets the security public filter's general setting configuration inf ## PARAMETERS ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityRegexAliaser.md index 8b6c72d14..63148f9d1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityRegexAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityRegexAliaser.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityRegexAliaser -Identity regex1 ``` @@ -39,11 +39,13 @@ This example retrieves a regular expression aliaser with an identity of "regex1" ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserFilter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserFilter.md index 61bd323a3..54f823781 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserFilter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserFilter.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityUserFilter -Identity ln1 -User user1 ``` @@ -39,13 +39,15 @@ This example gets the search security filter for user "user1" in user store "ln1 ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store containing the user. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: FAST Server for SharePoint 2010 + The identifier of the user or group. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStore.md index 5a449c0bf..690b1c005 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStore.md @@ -28,14 +28,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityUserStore -Identity ln1 ``` This example gets the user store with an identity of "ln1". -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityUserStore ``` @@ -45,14 +45,16 @@ This example gets a list of all user stores. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store to get. If not specified, the cmdlet gets a list of all user stores. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStoreGroupExpansion.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStoreGroupExpansion.md index 208e9c814..c485b996d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStoreGroupExpansion.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityUserStoreGroupExpansion.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityUserStoreGroupExpansion -Identity ln1 -User user1 ``` @@ -37,7 +37,7 @@ Get-FASTSearchSecurityUserStoreGroupExpansion -Identity ln1 -User user1 This example gets all the groups in the "ln1" user store that are parents, grand-parents, etc. of the "user1" user. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityWorkerNode workerserver | Get-FASTSearchSecurityUserStoreGroupExpansion -Identity ln2 -User user1 ``` @@ -48,13 +48,15 @@ of the "user1" user. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store to look in. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: FAST Server for SharePoint 2010 + The user or group identifier to look up. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -80,13 +84,15 @@ Accept wildcard characters: False ``` ### -Worker + +> Applicable: FAST Server for SharePoint 2010 + The optional Worker parameter specifies the WorkerPoolNode object for the security worker that is to handle the request. ```yaml Type: WorkerPoolNode Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityWorkerNode.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityWorkerNode.md index dae956239..2343bdd9d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityWorkerNode.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityWorkerNode.md @@ -38,14 +38,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityWorkerNode -Identity localhost ``` This example gets the status and complete URI for the worker with "localhost" in its URI. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityWorkerNode ``` @@ -55,14 +55,16 @@ This example returns a list of all workers, both active and inactive. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the worker to get. This is a URI or a partial URI, the server name for example. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -72,13 +74,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: FAST Server for SharePoint 2010 + If specified, get a list of all active workers. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -Dead + +> Applicable: FAST Server for SharePoint 2010 + If specified, get a list of all inactive workers. A worker is "dead" if it does not respond to requests from the security manager. This may occur if a worker machine goes down, or if there are network problems. @@ -95,8 +102,7 @@ This may occur if a worker machine goes down, or if there are network problems. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityXMLAliaser.md index e59f628b2..52af4a9d1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityXMLAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSecurityXMLAliaser.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSecurityAliaser ``` This example gets a list of all XML and regular expression principal aliasers. -### ---------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-FASTSearchSecurityAliaser -Identity xmlalias4 ``` @@ -48,14 +48,16 @@ This example gets the principal aliaser with the ID xmlalias4. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of a regular expression or XML aliaser to get. If not specified, the cmdlet gets a list of all aliasers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSpelltuningStatus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSpelltuningStatus.md index 295cd19d9..0cab80e3b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSpelltuningStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-FASTSearchSpelltuningStatus.md @@ -28,7 +28,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-FASTSearchSpelltuningStatus ``` diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-ProjectServerLicense.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-ProjectServerLicense.md index 28608fbc6..c38b67523 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-ProjectServerLicense.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-ProjectServerLicense.md @@ -26,7 +26,7 @@ Retrieves the status of the license for Project Server. If the current license i ## EXAMPLES -### Example 1 +### Example 1 ``` Get-ProjectServerLicense ``` @@ -36,6 +36,9 @@ Gets the status of the Project Server license and when it was activated. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServiceApplication.md index 69f011ff0..b5b5baa17 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServiceApplication.md @@ -33,21 +33,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1---------------- +### EXAMPLE 1 ``` Get-SPAccessServiceApplication -identity "MyAccessService" ``` This example displays an Access Services application named MyAccessService. -### ------------EXAMPLE 2---------------- +### EXAMPLE 2 ``` Get-SPAccessServiceApplication | where {$_.recordsintablemax -gt 10000} ``` This example displays every Access Services application that run in the farm, which allows more than 10,000 records in a table. -### ------------EXAMPLE 3---------------- +### EXAMPLE 3 ``` Get-SPAccessServiceApplication ``` @@ -57,6 +57,9 @@ This example displays every Access Services application in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Access Services application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPAccessServiceApplication object. @@ -64,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPAccessServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -75,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesApplication.md index d72d73a34..bd5a007f3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesApplication.md @@ -16,7 +16,6 @@ ms.reviewer: Gets an Access Services Service Application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Get-SPAccessServicesApplication [[-Identity] ] Returns Access Services service applications available in the farm. - ## EXAMPLES -### Example 1 +### Example 1 ``` $sa = Get-SPServiceApplication| ?{$_.TypeName -eq 'Access Services Web Service Application'} @@ -40,18 +38,19 @@ Get-SPAccessServicesApplication -Identity $sa ``` Returns the Access Services application using a service application pipebind. -### Example 2 +### Example 2 ``` Get-SPAccessServicesApplication -Identity 0d1da6e4-5cd6-4ccf-9ae1-ace2e964223a ``` Returns the Access Services application with the specified GUID. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -59,8 +58,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,14 +69,14 @@ Accept wildcard characters: False ### -Identity -Must be in the form of a Service Application pipe bind or a GUID. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Must be in the form of a Service Application pipe bind or a GUID. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabase.md index 4d5f51163..d71293f2f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabase.md @@ -28,13 +28,13 @@ Returns an Access Services database. ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPAccessServicesDatabase -Identity https://apps-eec88dc5f597c6.contoso-apps.com/sites/team/accessApp ``` Using the App Web, this example returns the Access database named 'accessApp'. -### Example 2 +### Example 2 ``` Get-SPAccessServicesDatabase -ContentDb WSS_Content ``` @@ -43,13 +43,15 @@ This example returns all Access databases associated with sites in the content d ## PARAMETERS ### -AccessAppsOnly + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns only Access Apps. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 2 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,13 +81,15 @@ Accept wildcard characters: False ``` ### -ContentDb + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The Content Database to return Access Apps from. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -93,13 +99,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URL to the Access App. Must be the App Web URL. ```yaml Type: AccessServicesDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServer.md index 386f10c1d..b426d20cb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServer.md @@ -36,25 +36,26 @@ Returns the SQL Server instances that are available for use with Access Services ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPAccessServicesDatabaseServer ``` Returns all SQL Server instances available for use. - -### Example 2 +### Example 2 ``` Get-SPAccessServicesDatabaseServer -DatabaseServer ACCSQL -ServiceContext https://siteUrl -DatabaseServergroup DEFAULT ``` Returns the database server ACCSQL from the DEFAULT database server group using the service context from https://siteUrl. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +63,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +73,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an existing Database Server associated with Access Services. ```yaml Type: AccessServicesDatabaseServerPipeBind Parameter Sets: GetSingleDatabaseServerParamterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,13 +91,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the database server group. ```yaml Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: GetSingleDatabaseServerParamterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: GetSingleDatabaseServerParamterSet, GetDatabaseServersParameterSet +Aliases: Required: True Position: Named @@ -104,27 +108,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: AccessServicesDatabaseServerGroupPipeBind -Parameter Sets: GetDatabaseServersParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -ServiceContext -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -ServiceContext Specifies the service context to retrieve Access Services database server information from. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroup.md index b03d824b8..ac57744a9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroup.md @@ -28,7 +28,7 @@ Returns a database server group associated with the given service context. ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPAccessServicesDatabaseServerGroup -ServiceContext http://siteUrl ``` @@ -37,6 +37,9 @@ Returns the database server group associated with the site, http://siteUrl. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the database server group. ```yaml Type: AccessServicesDatabaseServerGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context to retrieve Access Services database server information from. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroupMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroupMapping.md index 0df5417b9..ed17e25fe 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroupMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAccessServicesDatabaseServerGroupMapping.md @@ -27,7 +27,7 @@ This cmdlet shows the current mapping of the database server group associated wi ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPAccessServicesDatabaseServerGroupMapping -ServiceContext http://siteUrl ``` @@ -37,6 +37,9 @@ Outputs the database server group associated with the site, http://siteUrl. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context to retrieve Access Services database server information from. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -87,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -94,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAlternateURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAlternateURL.md index a74390066..c7cb9a550 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAlternateURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAlternateURL.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all alternate URLs that match a given set of criteria. - ## SYNTAX ### ResourceName @@ -48,14 +47,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPAlternateURL -WebApplication https://sitename ``` This example displays all the alternate URLs on a given Web application. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPAlternateURL -ResourceName "MyResource" ``` @@ -65,6 +64,9 @@ This example displays all the alternate URLs for a given resource. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the alternate URL to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or a valid URL, in the form https://server_name. @@ -72,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -ResourceName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the resource from which to list alternate URLs. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application from which to list alternate URLs. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -126,8 +134,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the five zones with which the alternate URLs is associated. Must be a valid zone: Default, Intranet, Internet, Extranet, or Custom @@ -144,8 +154,7 @@ Must be a valid zone: Default, Intranet, Internet, Extranet, or Custom ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAcquisitionConfiguration.md index 5f49f7703..7da49bdb5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAcquisitionConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAcquisitionConfiguration.md @@ -40,15 +40,14 @@ Use the `Get-SPAppAcquisitionConfiguration` cmdlet to return app acquisition set ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ``` Get-SPAppAcquisitionConfiguration -WebApplication https://localhost ``` This example returns app acquisition settings for the specified web application. - -### ------------EXAMPLE 2------- +### EXAMPLE 2 ``` Get-SPAppAcquisitionConfiguration -SiteSubscription https://localhost/sites/SharePointOnlineAdmin ``` @@ -59,13 +58,14 @@ This example returns app acquisition settings for the specified tenant. ### -SiteSubscription +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for which app acquisition settings are to be returned. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,6 +76,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +85,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,13 +96,14 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the web application for which app acquisition settings are to be returned. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAutoProvisionConnection.md index 739e3e0af..d7d5f99a7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAutoProvisionConnection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppAutoProvisionConnection.md @@ -17,7 +17,6 @@ ms.reviewer: Returns provision connection settings for an app. - ## SYNTAX ``` @@ -32,14 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1---------- +### EXAMPLE 1 ``` Get-SpAppAutoProvisionConnection ``` This example returns the entire app auto provisioning connection information for the default site subscription. -### ---------------EXAMPLE 2---------- +### EXAMPLE 2 ``` $subscription = Get-SPSiteSubscription https://Contoso.com Get-SPAppAutoProvisionConnection -SiteSubscription $subscription -ConnectionType RemoteWebHost @@ -50,6 +49,9 @@ This example returns the remote web host app auto provisioning connection inform ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -61,8 +63,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection type to provision the app. ```yaml Type: ConnectionTypes Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection from which to return the provision connection. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDeniedEndpointList.md index 19dd77941..d07a57c17 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDeniedEndpointList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDeniedEndpointList.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the app-denied endpoint list for the entire farm. - ## SYNTAX ``` @@ -30,21 +29,21 @@ Use the Get-SPAppEndpoint cmdlet to return the app-denied endpoint list for the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE---------- +### EXAMPLE ``` Get-SPAppDeniedEndpoint ``` This example returns all the app-denied endpoints within the farm. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -52,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDisablingConfiguration.md index 7111cc3bb..3e9855fd5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDisablingConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDisablingConfiguration.md @@ -29,21 +29,21 @@ Use the Get-SPAppDisablingConfiguration cmdlet to return the disable sync list s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------- +### EXAMPLE ``` Get-SPAppDisablingConfiguration ``` This example returns disable list sync state of a pp. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDomain.md index 28f03f66d..b178bca6f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppDomain.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the domain used to host apps. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Get-SPAppDomain ``` @@ -41,6 +40,9 @@ This example returns the domain name that hosts apps in the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppHostingQuotaConfiguration.md index 13b854fe7..9a4c39023 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppHostingQuotaConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppHostingQuotaConfiguration.md @@ -29,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1--------- +### EXAMPLE 1 ``` Get-SPAppHostingQuotaConfiguration -Identity '586d4a32-98c3-42ce-80be-3c76c10c250c' ``` This example returns the hosted app quota associated to SiteSubscriptionID "586d4a32-98c3-42ce-80be-3c76c10c250c". -### --------------EXAMPLE 1--------- +### EXAMPLE 1 ``` Get-SPSiteSubscription | Get-SPAppHostingQuotaConfiguration -Identity $_ ``` @@ -47,6 +47,8 @@ This example returns the hosted app quota associated for all site subscriptions ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -54,8 +56,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,13 +67,14 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -83,6 +85,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -90,7 +94,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription from which to get site collections. The type must be a valid URL, in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -107,8 +113,7 @@ The type must be a valid URL, in the form, https://server_name or a valid GUID ( ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppInstance.md index a13b879a1..6fe771bac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppInstance.md @@ -47,7 +47,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE 1----------- +### EXAMPLE 1 ``` Get-SPAppInstance -Web https://localhost ``` @@ -55,7 +55,7 @@ Get-SPAppInstance -Web https://localhost This example returns a collection if more than one app is installed on https://localhost. If only one app is installed, a single object is returned. -### -----------EXAMPLE 2----------- +### EXAMPLE 2 ``` Get-SPAppInstance -AppInstanceId $instance.Id ``` @@ -65,13 +65,15 @@ This example returns the ID of an instance of an app. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the App instance for which to find metadata. ```yaml Type: SPAppInstance Parameter Sets: IdentityParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the query scope to a site. Subsites are not included. @@ -88,8 +93,7 @@ Subsites are not included. ```yaml Type: SPSitePipeBind Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +103,9 @@ Accept wildcard characters: False ``` ### -App + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the App. This parameter returns metadata for all instances of an app. @@ -106,8 +113,7 @@ This parameter returns metadata for all instances of an app. ```yaml Type: SPApp Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +123,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -128,8 +137,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,13 +147,15 @@ Accept wildcard characters: False ``` ### -AppInstanceId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the App Instance ID to display. ```yaml Type: Guid Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -155,13 +165,15 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWeb object. ```yaml Type: SPWebPipeBind Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppPrincipal.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppPrincipal.md index 3660d1d31..0fc5265a6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppPrincipal.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppPrincipal.md @@ -17,7 +17,6 @@ ms.reviewer: Displays a specific app principal object. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE-------- +### EXAMPLE ``` Get-SPAppPrincipal -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" ``` @@ -42,13 +41,15 @@ This example returns the app principal for a specified ID. ## PARAMETERS ### -NameIdentifier + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app principal's name identifier to search for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,11 +59,13 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +89,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppScaleProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppScaleProfile.md index d92763456..7ca442f0d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppScaleProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppScaleProfile.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Get-SPAppScaleProfile ``` @@ -40,6 +40,8 @@ This example returns the farm level app scale profile. ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppSiteSubscriptionName.md index 86c3c0f2d..b8744ccf9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppSiteSubscriptionName.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppSiteSubscriptionName.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the name of the specified site subscription. - ## SYNTAX ``` @@ -32,14 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ``` Get-SPAppSiteSubscriptionName ``` This example returns the name of the default site subscription. -### ------------EXAMPLE 2------- +### EXAMPLE 2 ``` Get-SPAppSiteSubscriptionName -SiteSubscription https://www.contoso.com ``` @@ -49,6 +48,9 @@ This example returns the name of the site subscription for SPSite https://www.co ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -60,8 +62,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,6 +72,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. If this parameter is not specified, then the default site subscription is used. All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. @@ -78,8 +82,7 @@ All SharePoint SPSites are members of the default site subscription if they have ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateSyncLastRunTime.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateSyncLastRunTime.md index bdfdabbb8..b6a62aa94 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateSyncLastRunTime.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateSyncLastRunTime.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the latest time the app state update job was invoked. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------ +### EXAMPLE ``` Get-SPAppStateSyncLastRunTime ``` @@ -42,6 +41,9 @@ This example returns the latest time the app state update job was invoked. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateUpdateInterval.md index 317ebf103..c7e37ad85 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStateUpdateInterval.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ``` Get-SPAppStateUpdateInterval ``` @@ -40,6 +40,9 @@ This example returns the app state update timer job invocation interval in hours ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreConfiguration.md index a1180d365..f9907504e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreConfiguration.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ``` Get-SPAppStoreConfiguration ``` @@ -41,6 +41,8 @@ This example returns the settings for all of the apps. ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreWebServiceConfiguration.md index ad3838126..9d693f1e6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreWebServiceConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAppStoreWebServiceConfiguration.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPAppStoreWebServiceConfiguration ``` @@ -40,6 +40,9 @@ This example returns the product type and version for a SharePoint Store app. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationProvider.md index 9223d4440..1ca116296 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationProvider.md @@ -17,7 +17,6 @@ ms.reviewer: Returns an authentication provider. - ## SYNTAX ``` @@ -34,16 +33,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPAuthenticationProvider -WebApplication https://webAppUrl -Zone Default ``` -This example retrieves the authentication provider in the Default zone of the Web Application 'https://webAppUrl'. +This example retrieves the authentication provider in the Default zone of the Web Application 'https://webAppUrl'. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint authentication provider (for example, NTLM); or an instance of a valid SPAuthenticationProvider object. @@ -51,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPAuthenticationProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the content databases for the specified Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -69,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application zone or zones for which to return the authentication provider. The type must be any one of the valid zones: Default, Intranet, Internet, Extranet, or Custom. @@ -87,8 +93,7 @@ The type must be any one of the valid zones: Default, Intranet, Internet, Extran ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 3 @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -105,8 +113,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationRealm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationRealm.md index 13bc959a2..c56c54386 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationRealm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPAuthenticationRealm.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------- +### EXAMPLE ``` Get-SPAuthenticationRealm ``` @@ -40,14 +40,16 @@ This example displays the authentication realms in the entire farm. ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the realm needs to be displayed. For example, $root.web. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBackupHistory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBackupHistory.md index 9dab06409..91fe903da 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBackupHistory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBackupHistory.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a history of backup and restore operations. - ## SYNTAX ``` @@ -33,21 +32,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPBackupHistory -Directory \\file_server\share\Backup ``` This example returns all farm backup and restore operations that have been run for the \\\\file_server\share\Backup directory. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPBackupHistory -Directory C:\Backup -ShowBackup ``` This example returns all of the farm backup operations that have been run for the C:\Backup directory. -### ------------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` (Get-SPBackupHistory -Directory C:\Backup -ShowBackup)[0].SelfId | Restore-SPFarm -Directory C:\Backup -RestoreMethod overwrite ``` @@ -58,6 +57,9 @@ The Restore-SPFarm cmdlet will then perform an overwrite restore from that backu ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path where the SharePoint Products backup packages generated from a farm backup have been stored. The type must be a valid path in either of the following forms: @@ -68,8 +70,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,14 +104,16 @@ Accept wildcard characters: False ``` ### -ShowBackup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters the output so that the history of backup operations only is displayed. If both the ShowBackup and the ShowRestore parameters are not specified, the history of both backup and restore operations is displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,14 +123,16 @@ Accept wildcard characters: False ``` ### -ShowRestore + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters the output so that the history of restore operations only is displayed. If both the ShowBackup and the ShowRestore parameters are absent, the history of both backup and restore operations is displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsBlock.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsBlock.md index 9093cfbac..c6bae2eac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsBlock.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsBlock.md @@ -17,7 +17,6 @@ ms.reviewer: Returns Bing Maps blocked status. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ``` Get-SPBingMapsBlock ``` @@ -42,6 +41,9 @@ This example returns an object, and BlockBingMapsInAllLocales property will retu ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsKey.md index 6a807f069..553fdd615 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBingMapsKey.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the Bing Maps key. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ``` Get-SPBingMapsKey ``` @@ -41,6 +40,9 @@ This example returns the Bing Maps key for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBrowserCustomerExperienceImprovementProgram.md index 134ada23d..14f32cc71 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBrowserCustomerExperienceImprovementProgram.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBrowserCustomerExperienceImprovementProgram.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the current opt-in state for the browser Customer Experience Improvement Program. - ## SYNTAX ### Farm @@ -49,14 +48,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Get-SPBrowserCustomerExperienceImprovementProgram -WebApplication https://WebAppexample1 ``` This example returns the current Customer Experience Improvement Program opt-in state for the Web application, WebAppexample1. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPSiteSubscription https://SiteSubscription1 | Get-SPBrowserCustomerExperienceImprovementProgram ``` @@ -66,13 +65,15 @@ The following example returns the Customer Experience Improvement Program opt-in ## PARAMETERS ### -Farm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the opt-in state for the farm is returned by this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the opt-in state for the specified site subscription. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. @@ -89,8 +93,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the opt-in state for the specified SharePoint Web application. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -107,8 +113,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -125,8 +133,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogEntityNotificationWeb.md index d7558e0e9..b8898518e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogEntityNotificationWeb.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the entity notification site. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------EXAMPLE----------- +### EXAMPLE ``` Get-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso" ``` @@ -42,13 +41,15 @@ This example returns the entity notification site for the site collection at htt ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the entity notification web has to be returned. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogMetadataObject.md index 4a1f3210b..0adf261be 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogMetadataObject.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceConext http://contoso ``` @@ -45,6 +44,9 @@ This example gets a metadata object of type Model with the name ContosoModel fro ## PARAMETERS ### -BdcObjectType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of the metadata object to return. The type must be one of the following valid metadata object types: Catalog, Model, LobSystem, LobSystemInstance, or Entity. @@ -52,8 +54,7 @@ The type must be one of the following valid metadata object types: Catalog, Mode ```yaml Type: PSBdcObjectType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context of the Business Data Connectivity Metadata Store metadata object to return. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -86,8 +92,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the metadata object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -Namespace + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the namespace of the metadata object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -ContainingLobSystem + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the LobSystem. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogThrottleConfig.md index ec6f00992..c3d1e2cbe 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogThrottleConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPBusinessDataCatalogThrottleConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the throttling configuration for a Business Data Connectivity Service application. - ## SYNTAX ### FileBackedProvided @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy ``` @@ -54,13 +53,15 @@ This example returns the throttling information that is related to database item ## PARAMETERS ### -FileBacked + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Requests the throttling configuration for file backed metadata catalogs. ```yaml Type: SwitchParameter Parameter Sets: FileBackedProvided -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the throttling configuration for the specified the scope. The type must be one of the following: Wcf, WebService, Database, Global, or Custom. @@ -77,8 +81,7 @@ The type must be one of the following: Wcf, WebService, Database, Global, or Cus ```yaml Type: ThrottleScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Service application proxy that contains the throttling configuration to get. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: ProxyProvided -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -ThrottleType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the throttling configuration for the specified throttle type. The type must be one of the following: None, Items, Size, Connections, or Timeout. @@ -111,8 +119,7 @@ The type must be one of the following: None, Items, Size, Connections, or Timeou ```yaml Type: ThrottleType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -129,8 +139,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCertificateAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCertificateAuthority.md index 3d2716977..7e83eeef7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCertificateAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCertificateAuthority.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the SharePoint certificate authority (CA). - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPCertificateAuthority ``` @@ -41,6 +40,9 @@ This example gets the certificate authority. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProvider.md index ab83bdc76..770491bfa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProvider.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a claim provider. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPClaimProvider -Identity "MyClaimProvider" | Set-SPClaimProvider -Enabled $false ``` @@ -42,6 +41,9 @@ This example disables the claim provider MyClaimProvider. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claim provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProviderManager.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProviderManager.md index 17fb776b6..ea311b5aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProviderManager.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimProviderManager.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a claim provider manager. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------- +### EXAMPLE ``` Get-SPClaimProviderManager ``` @@ -41,6 +40,9 @@ This example returns a claim provider manager for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimTypeEncoding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimTypeEncoding.md index 99e354a24..eec657807 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimTypeEncoding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPClaimTypeEncoding.md @@ -27,29 +27,26 @@ Get-SPClaimTypeEncoding [-AssignmentCollection ] [-Claim Use the Get-SPClaimTypeEncoding cmdlet to return the following: - -- A list of all the types of claims that are registered in the farm -- The Unicode character that will be encoded when the SPClaim.ToEncodedString method is invoked -- The SPClaim.ClaimType property is set to a valid value - For additional information about the SPClaim methods and properties, see M:Microsoft.SharePoint.Administration.Claims.SPClaim.ToEncodedString and P:Microsoft.SharePoint.Administration.Claims.SPClaim.ClaimType respectively. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------- +### EXAMPLE 1 ``` Get-SPClaimTypeEncoding ``` This example returns a list of all types of claima in the farm. -### --------------EXAMPLE 2-------- +### EXAMPLE 2 ``` Get-SPClaimTypeEncoding -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" ``` @@ -59,6 +56,9 @@ This example returns a specific claim type by using the ClaimType parameter. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,13 +76,15 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an encoding character that is mapped to a type of input claim. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,13 +94,15 @@ Accept wildcard characters: False ``` ### -EncodingCharacter + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a type of claim that is mapped to an input character. ```yaml Type: Char Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPConnectedServiceApplicationInformation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPConnectedServiceApplicationInformation.md index 6696a0d50..fb7573880 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPConnectedServiceApplicationInformation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPConnectedServiceApplicationInformation.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### Example 1 +### Example 1 ``` $validProxy = $false $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq "User Profile Service Application Proxy"} @@ -47,6 +47,9 @@ This example checks the health of the service application proxy server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -54,8 +57,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabase.md index f4109ec39..f257b5772 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Returns one or more content databases. - ## SYNTAX ### DefaultSet @@ -60,21 +59,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1------------ +### EXAMPLE 1 ``` Get-SPContentDatabase -WebApplication https://webAppUrl ``` This example returns all content databases used by the sitename Web application. -### ----------------EXAMPLE 2------------ +### EXAMPLE 2 ``` Get-SPContentDatabase -Site https://siteUrl ``` This example returns the content database that contains the site collection at https://siteUrl. -### ----------------EXAMPLE 3------------ +### EXAMPLE 3 ``` PS C:\>Get-SPContentDatabase -DaysSinceLastProfileSync 7 ``` @@ -83,6 +82,9 @@ This example returns all content databases that were last synchronized with the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a specific content database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -90,8 +92,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -101,6 +102,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the content database for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -108,8 +112,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: ContentDatabasesOfSite -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -119,6 +122,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the content databases for the specified Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -126,8 +132,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -144,8 +152,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +162,15 @@ Accept wildcard characters: False ``` ### -ConnectAsUnattachedDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only unattached databases in the farm are returned. ```yaml Type: SwitchParameter Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -178,8 +190,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +200,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database in the farm. ```yaml Type: String Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -205,13 +218,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server in the farm. ```yaml Type: String Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -234,8 +249,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` - ### -NoStatusFilter + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether a status filter is turned on. The valid values are True or False. The default value is False. @@ -243,8 +260,7 @@ The valid values are True or False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: DefaultSet, AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabaseOrphanedData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabaseOrphanedData.md index bf706d9de..6c3eb03b3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabaseOrphanedData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDatabaseOrphanedData.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Gets orphaned data in content database. - ## SYNTAX ``` @@ -23,7 +22,6 @@ Get-SPContentDatabaseOrphanedData [-Identity] [-AssignmentCollection ] [] ``` - ## DESCRIPTION Use the **Get-SPContentDatabaseOrphanedData** to display orphaned objects. @@ -38,13 +36,16 @@ This example gets orphan objects in content database named "WSS_Content". ## PARAMETERS ### -Identity -Specifies the GUID of the content database to get. + +> Applicable: SharePoint Server 2019 + +Specifies the GUID of the content database to get. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2019 + Required: True Position: 1 Default value: None @@ -53,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,7 +69,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -77,5 +81,4 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentJob.md index ea9aace10..10328fafa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentJob.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Get-SPContentDeploymentJob -Identity 'Job 1' ``` @@ -41,6 +41,9 @@ This example returns the content deployment job called Job 1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment job to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that content deployment jobs for only the specified content deployment path are returned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. @@ -88,8 +95,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentPath.md index a269544eb..06ffef22a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPContentDeploymentPath.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ``` Get-SPContentDeploymentPath -Identity 'Path 1' ``` @@ -40,6 +40,9 @@ This example returns the content deployment path named Path 1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment path to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example, DeployPath1); or an instance of a valid SPContentDeploymentJob object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -65,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCustomLayoutsPage.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCustomLayoutsPage.md index 191bed562..f632ff9a4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCustomLayoutsPage.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPCustomLayoutsPage.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a mapping to a custom layout page. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPCustomLayoutsPage -Identity '_layouts/accessdenied.aspx' -WebApplication 'https://webAppUrl' ``` @@ -44,6 +43,9 @@ This example returns the mapping of the AccessDenied layout page in the Web appl ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web application that contains the custom layout page. The type must be a valid URL, in the form https://webAppUrl; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -51,8 +53,7 @@ The type must be a valid URL, in the form https://webAppUrl; a valid GUID, in th ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -69,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom layout page to get. The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. @@ -87,8 +93,7 @@ The type must be one of the following: None, AccessDenied, Confirmation, Error, ```yaml Type: SPCustomPage Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFile.md index 0f73553da..b424efdf7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFile.md @@ -30,21 +30,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPDataConnectionFile ``` This example lists the Identity, DisplayName, and WebAccessible properties ofeach .udcx file. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` C:\PS>"Sample.udcx" | Get-SPDataConnectionFile ``` This example lists the Identity, DisplayName, and WebAccessible properties of the specified file, named Sample.udcx. -### ---------------EXAMPLE 3-------------- +### EXAMPLE 3 ``` Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} ``` @@ -54,6 +54,9 @@ This example lists the Identity, DisplayName, and WebAccessible properties of al ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the data file connection to get. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -61,8 +64,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFileDependent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFileDependent.md index f16b452a7..77d70a9a5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFileDependent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDataConnectionFileDependent.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPDataConnectionFileDependant -Identity 'FileName.udcx' ``` @@ -39,6 +39,9 @@ This example displays a list of deployed forms with a specified name. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the data connection file to get. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDatabase.md index 18425e531..9126754f2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves all properties of a database. - ## SYNTAX ### DefaultParameterSet @@ -49,14 +48,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Get-SPDatabase | ?{$_.TypeName -eq 'Microsoft.Office.Server.Administration.ProfileDatabase'} ``` This example gets the Profile database used by the User Profile Service Application. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Get-SPDatabase -Name 'Profile DB' ``` @@ -66,6 +65,9 @@ This example gets the Profile database by name. Applies to SharePoint Server 201 ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to display public properties. The type must be a valid GUID, in the form 1234-3456-567kg. @@ -73,8 +75,7 @@ The type must be a valid GUID, in the form 1234-3456-567kg. ```yaml Type: SPDatabasePipeBind Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SQL instance that contains the database in either the form "Server" for a default SQL instance or "Server\Instance" for a named SQL instance. ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: ServerParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -107,8 +113,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database. ```yaml Type: String Parameter Sets: NameParameterSet -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDeletedSite.md index 960f9df46..da5974fa1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDeletedSite.md @@ -17,7 +17,6 @@ ms.reviewer: Gets a list of deleted site collections. - ## SYNTAX ``` @@ -46,21 +45,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Get-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c ``` This example gets a specific deleted site collection by using a site ID. -### ------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Get-SPDeletedSite "/" ``` This example gets a deleted site collection from the root site. -### ------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Get-SPDeletedSite '/Site/cat*' ``` @@ -71,6 +70,9 @@ The asterisk (*) wildcard character requests a match for multiple characters. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to get. The identity can be either a valid server-relative URL in the form /sites/site_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -78,8 +80,7 @@ The identity can be either a valid server-relative URL in the form /sites/site_n ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +104,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -135,8 +143,7 @@ The type must be a valid database name in the form SPContentDB01 or a valid GUID ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -DateTimeFrom + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,13 +171,15 @@ Accept wildcard characters: False ``` ### -DateTimeTo + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,6 +189,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits the maximum number of site collections to return. The default value is 1000. @@ -187,8 +201,7 @@ Specify ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription from which to get site collections. The type must be a valid URL in the form https://server_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -205,8 +221,7 @@ The type must be a valid URL in the form https://server_name or a valid GUID, fo ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -223,8 +241,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -241,7 +261,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDesignerSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDesignerSettings.md index 8d270ed3c..7e1346b94 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDesignerSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDesignerSettings.md @@ -17,7 +17,6 @@ ms.reviewer: Displays SharePoint Designer features. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE------------------------ +### EXAMPLE ``` Get-SPDesignerSettings -webapplication https://contoso ``` @@ -42,13 +41,15 @@ This example retrieves the SharePoint Designer settings for the Web application, ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application in which the settings apply. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticConfig.md index 7a68c7e5e..1fc1ebb1e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves ULS diagnostic configuration values of the farm. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPDiagnosticConfig ``` @@ -41,6 +40,9 @@ This example returns all diagnostic configuration values. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsPerformanceCounter.md index dc9ac685c..fea05d4b1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsPerformanceCounter.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a collection of performance counters. - ## SYNTAX ``` @@ -38,21 +37,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPDiagnosticsPerformanceCounter ``` This example gets the performance counter settings for front end Web servers and database servers. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPDiagnosticsPerformanceCounter -WebFrontEnd ``` This example gets the performance counter settings for front end Web servers. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Get-SPDiagnosticsPerformanceCounter -DatabaseServer ``` @@ -62,6 +61,9 @@ This example gets the performance counter settings for database servers. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -69,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns performance counters collected for the database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns performance counters collected for the front end Web servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsProvider.md index bd0d9fad8..cef9b02a0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDiagnosticsProvider.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a diagnostics provider. - ## SYNTAX ``` @@ -33,14 +32,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPDiagnosticsProvider ``` This example returns all the diagnostics providers in the farm. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPDiagnosticsProvider job-diagnostics-event-log-provider ``` @@ -50,6 +49,9 @@ This example returns the event log diagnostics provider. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the diagnostics provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticsProv1); or an instance of a valid SPDiagnosticsProvider object. @@ -57,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPDiagnosticsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +83,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDistributedCacheClientSetting.md index a5817278a..efd10c05c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDistributedCacheClientSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPDistributedCacheClientSetting.md @@ -17,7 +17,6 @@ ms.reviewer: Returns distributed cache settings from usage. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE-------- +### EXAMPLE ``` Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache ``` @@ -44,6 +43,8 @@ This example returns the Distributed Cache client settings for DistributedLogonT ### -ContainerType +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the container type to clear. The valid values are the following: @@ -69,12 +70,10 @@ The valid values are the following: -DistributedViewStateCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -84,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEduServiceSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEduServiceSetting.md index e51169e79..eeed946af 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEduServiceSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEduServiceSetting.md @@ -27,23 +27,24 @@ Do not use ## EXAMPLES -### Example 1 +### Example 1 ``` Do not use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -53,14 +54,16 @@ Accept wildcard characters: False ``` ### -Service + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: Services Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Lync, Exchange, StudyGroup -Applicable: SharePoint Server 2013 Required: True Position: 0 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchAdministrationComponent.md index f2fbeebae..b65827b90 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchAdministrationComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchAdministrationComponent.md @@ -29,7 +29,7 @@ For permissions and the most current information about search cmdlets, see the o ## EXAMPLES -### Example 1 +### Example 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa @@ -40,6 +40,9 @@ This example obtains an object reference to the administration component of a se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the administration component. The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890 ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchComponent.md index 73301b0e6..7ead90d8f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchComponent.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves one or all search components in a given search topology. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -Identity '06e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa @@ -42,7 +41,7 @@ Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b61 This example retrieves the search component with the identity 06e6651d-ecdd-4105-bb65-6a83b6155525 from the search topology with identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa @@ -53,13 +52,15 @@ This example retrieves all search components from the search topology with the i ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity for a search component. ```yaml Type: SearchComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -69,13 +70,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology from which to retrieve the search component/search components. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -92,8 +98,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology and search component/search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md index 47b7f7c1b..e8fc57f99 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the content enrichment configuration for the specified search service application. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa @@ -43,13 +42,15 @@ This example retrieves the ContentEnrichmentConfiguration object from the defaul ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlContentSource.md index db10bde63..2806e2a6e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlContentSource.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Identity 'Local SharePoint Sites' @@ -43,6 +43,9 @@ This example retrieves the default content source for the search service applica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content source to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -68,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -86,8 +93,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlCustomConnector.md index 2c7b7ca30..819a99c52 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlCustomConnector.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE---------------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -Protocol 'http://' @@ -41,13 +41,15 @@ This example obtains a reference to all custom crawl connectors for the http:// ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Search application with which the CustomConnector objects are associated. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string version of the protocol for which to return the CustomConnector object, for example, "dctm://" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlDatabase.md index fc9f11e68..ed3f02284 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlDatabase.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE------------------- +### EXAMPLE ``` Get-SPEnterpriseSearchCrawlDatabase -SearchApplication 'Search Service Application' -Identity CrawlDB_1 ``` @@ -43,6 +43,9 @@ This example gets a reference to the crawl database CrawlDB_1 from the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a CrawlStore object, in the form CrawlStore1; or an instance of a valid CrawlStore object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -68,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -86,8 +93,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlExtension.md index aa89853ab..27faa623e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlExtension.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### Add code example. +### Add code example. ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlExtension -Identity 'pdf' -SearchApplication $ssa @@ -44,6 +44,9 @@ This example checks whether the pdf file type is included in the file types to b ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extension to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ExtensionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the extension collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +94,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlLogReadPermission.md index e196937fb..a77e0f67e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlLogReadPermission.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant '00000000-0000-0000-0000-000000000001' @@ -43,14 +43,16 @@ This example retrieves a list of users who have permission to view the crawl log ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application for which to list crawl log permissions. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +72,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,14 +82,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the list of users shall be within the scope of this tenant. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlMapping.md index bfc33e3fa..48b17e951 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlMapping.md @@ -44,6 +44,9 @@ This example returns the crawl mappings for the search application 'Search Servi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl mapping to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://crawlmap1; or an instance of a valid CrawlMapping object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: CrawlMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +94,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlRule.md index 3b0294601..8d2fc6d97 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchCrawlRule.md @@ -30,15 +30,15 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` -$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' +$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Identity https://webAppUrl ``` This example uses the `Get-SPEnterpriseSearchCrawlRule` cmdlet to retrieve a crawl rule. -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlRule -SearchApplication $searchApp | ?{$_.Path -like '*example*'} @@ -49,6 +49,9 @@ This example returns a list of crawl rules with paths that contain the word exam ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search crawl rule path. A valid URL, such as "https://webAppUrl", or an instance of a valid CrawlRule object @@ -56,8 +59,7 @@ A valid URL, such as "https://webAppUrl", or an instance of a valid CrawlRule ob ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -67,6 +69,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl rule. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object @@ -74,8 +79,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -92,8 +99,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchFileFormat.md index ceeb3b7b0..4996753a9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchFileFormat.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves all parseable file formats. - ## SYNTAX ``` @@ -34,10 +33,9 @@ If no format ID is provided, the cmdlet returns all the parseable file formats. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ``` C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa @@ -45,7 +43,7 @@ Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa This example uses the Get-SPEnterpriseSearchFileFormat to retrieve all parseable file formats in the search service application referenced by $ssa. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity DOCX @@ -56,13 +54,15 @@ This example uses the Get-SPEnterpriseSearchFileFormat cmdlet to retrieve inform ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format ID for which to retrieve file format information. ```yaml Type: DocumentParserFileFormatPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -73,6 +73,8 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application for which to retrieve file format information. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -80,8 +82,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -98,8 +102,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchHostController.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchHostController.md index 74466dc96..c94e55497 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchHostController.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchHostController.md @@ -31,14 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPEnterpriseSearchHostController ``` This example retrieves a list of all HostControllers in the farm with their status (primary/secondary) and repository version. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssi = Get-SPEnterpriseSearchServiceInstance -Local Get-SPEnterpriseSearchHostController -SearchServiceInstance $ssi @@ -49,6 +49,9 @@ This example retrieves the status information for the SearchHostController on th ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -56,8 +59,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -SearchServiceInstance + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The Search Service instance of the server from where the SearchHostController object is returned. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLanguageResourcePhrase.md index 3feda3d4e..f37e5e6e4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLanguageResourcePhrase.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language 'en-us' -Type QuerySuggestionBlockList @@ -43,6 +43,8 @@ This example returns all language resource entries for the en-us language in the ### -AssignmentCollection +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,12 +54,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -68,17 +68,17 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language resource phrase to get. The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - ```yaml Type: LanguageResourcePhrasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -89,17 +89,17 @@ Accept wildcard characters: False ### -Language +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return phrases of a specified source language. The type must be a valid name of a language; for example, en-us or ja-jp. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,18 +110,18 @@ Accept wildcard characters: False ### -Mapping +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +132,8 @@ Accept wildcard characters: False ### -Owner +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -142,12 +144,10 @@ The owner must be one of the following valid levels: - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -158,17 +158,17 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -179,15 +179,15 @@ Accept wildcard characters: False ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +198,8 @@ Accept wildcard characters: False ### -Type +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return phrases of a specified type. The type must be one of the following valid types of phrases: @@ -208,12 +210,10 @@ The type must be one of the following valid types of phrases: - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinguisticComponentsStatus.md index bf7b61c0a..86967acba 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinguisticComponentsStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinguisticComponentsStatus.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa @@ -41,13 +41,15 @@ This example gets the current status of the linguistic query and document proces ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + An object that represents the current status of the linguistic components. ```yaml Type: LinguisticComponentsStatusPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the linguistic processing components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -80,8 +87,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinksDatabase.md index 7941b57a2..024bfd27f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchLinksDatabase.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------EXAMPLE--------- +### EXAMPLE ``` Get-SPEnterpriseSearchLinksDatabase -Identity LinksDB_1 -SearchApplication 'Search Service Application' ``` @@ -42,6 +42,9 @@ This example gets a reference to the links database LinksDB_1 from the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the links database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. @@ -49,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -67,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -85,8 +92,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCategory.md index c22e252af..cc8c6146d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCategory.md @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa @@ -45,6 +45,9 @@ This example retrieves the metadata category collection of a search service appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata category to retrieve. The type must a valid search application name, for example, MetadataCategory1, or an instance of a valid Category object. @@ -52,8 +55,7 @@ The type must a valid search application name, for example, MetadataCategory1, o ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the enterprise search metadata categories. The type must a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -70,8 +75,7 @@ The type must a valid search application name, for example, SearchApp1, or an in ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -88,8 +95,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata categories returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -106,8 +115,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +125,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata categories returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -124,8 +135,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCrawledProperty.md index 3cb68432f..9af0f3fe2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataCrawledProperty.md @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People @@ -47,6 +47,8 @@ This example returns the first crawled property in the PeopleSearch_Scope metada ### -AssignmentCollection +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -54,8 +56,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,6 +67,8 @@ Accept wildcard characters: False ### -Category +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata category of the crawled property to return. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. @@ -74,7 +77,6 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, Type: CategoryPipeBind Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -85,6 +87,8 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items to return. Specify ALL to return all possible results. @@ -92,8 +96,7 @@ Specify ALL to return all possible results. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,8 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawled property to retrieve. The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" @@ -111,8 +116,7 @@ The type must be a valid crawled property name, for example "urn:schemas-microso ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +127,8 @@ Accept wildcard characters: False ### -PropSet +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to return crawled properties that use the specified property set. A property set belongs to one crawled property category. @@ -132,7 +138,6 @@ The type must be a valid GUID that specifies the property set in the form 123456 Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -143,6 +148,8 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawled property. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -150,8 +157,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -162,6 +168,8 @@ Accept wildcard characters: False ### -SiteCollection +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -169,8 +177,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +188,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -188,8 +197,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,17 +208,17 @@ Accept wildcard characters: False ### -VariantType +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to return crawled properties that use the specified variant type. The type must be an integer that specifies the variant data type of the property set. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: vt -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataManagedProperty.md index 78d794ac9..125ecf88b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataManagedProperty.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -43,6 +43,9 @@ This example retrieves the managed property UserName from the default search ser ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to retrieve. The type must be a valid name of metadata property, for example MetadataProperty1, or an instance of a valid ManagedProperty object. @@ -50,8 +53,7 @@ The type must be a valid name of metadata property, for example MetadataProperty ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -68,8 +73,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -86,8 +93,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,14 +103,16 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of managed properties to return. Specify ALL to return all possible results. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -121,8 +132,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +142,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -139,8 +152,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataMapping.md index d3cda836c..56a5a6637 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchMetadataMapping.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -43,6 +43,9 @@ This example lists all crawled properties mapped to the managed property UserNam ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the metadata mapping. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -50,8 +53,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -68,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -CrawledProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawled property from which to return mappings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -86,8 +93,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property from which to return mappings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -104,8 +113,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -122,8 +133,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +143,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mappings returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -140,8 +153,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchOwner.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchOwner.md index a783df3d3..4cfa9c45b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchOwner.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchOwner.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` Get-SPEnterpriseSearchOwner -Level SPSite ``` @@ -40,13 +40,15 @@ This example shows how to retrieve the tenant owner of a search object at the SP ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner to retrieve. ```yaml Type: SearchObjectOwner Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the owner object resides at the SPWeb, SPSite, SPSite Subscription, or SSA level. ```yaml Type: SearchObjectLevel Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,14 +100,16 @@ Accept wildcard characters: False ``` ### -SPWeb + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWeb or SPSite in which this object resides. It is only needed if Level is equal to SPWeb or SPSite. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRule.md index 1e731d0ef..79be8e6b4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRule.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -44,13 +44,15 @@ The second step specifies the value that the property shall start with. ## PARAMETERS ### -PropertyName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the property that the rule concerns. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,13 +62,15 @@ Accept wildcard characters: False ``` ### -Operator + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the operation to apply to the property, for example "Starts with". ```yaml Type: DefaultOperator Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +90,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRuleCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRuleCollection.md index e881eac37..0cff7afea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRuleCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchPropertyRuleCollection.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -45,6 +45,9 @@ Thereafter the example returns the rule collection, and adds the rule to the rul ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -52,8 +55,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md index df0e255da..7180b4e7a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$qssService = Get-SPEnterpriseSearchQUeryAndSiteSettingsService ``` @@ -40,6 +40,9 @@ This example obtains a reference to the query and site settings service. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index c573afcad..ed52233b3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` C:\PS>$qqssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local ``` This example obtain a reference to the query and site setting service instance on the local farm. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` C:\PS>$qssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity myServer ``` @@ -47,6 +47,9 @@ This example obtain a reference to the query and site setting service instance f ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search manager service instance to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid server name on which search manager service instance runs; or an instance of a valid SearchManagerServiceInstance object. @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +91,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service manager service instance for the current search server is returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md index 61dcffc6c..d4e85b2d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$qssSvcProxy = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy ``` @@ -39,6 +39,9 @@ This example obtains a reference to the query and site settings service proxy. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAuthority.md index eb300ad1c..b612731dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryAuthority.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' Get-SPEnterpriseSearchQueryAuthority -Identity 'https://contoso.com' -SearchApplication $ssa @@ -40,7 +40,7 @@ Get-SPEnterpriseSearchQueryAuthority -Identity 'https://contoso.com' -SearchAppl This example obtains the authoritative page for the URL https://contoso.com from the search service application named 'Search Service Application'. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPEnterpriseSearchQueryAuthority -SearchApplication 'Search Service Application' ``` @@ -50,6 +50,9 @@ This example obtains the collection of query authority pages from a search servi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query authority to get. The type must be a valid URL, in the form https://server_name; or an instance of a valid AuthorityPage object. @@ -57,8 +60,7 @@ The type must be a valid URL, in the form https://server_name; or an instance of ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -68,13 +70,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the authority page to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -91,8 +98,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +108,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +122,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryDemoted.md index 64efa5cc7..522f13bbc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryDemoted.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity https://somesite.com -SearchApplication 'Search Service Application' Remove-SPEnterpriseSearchQueryDemoted -Identity $demotedRule -SearchApplication 'Search Service Application' @@ -43,6 +43,9 @@ This example obtains a reference to a site demotion rule for the URL https://som ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the demoted site rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance a valid Demoted object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: DemotedPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,13 +63,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the demoted site rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -84,8 +91,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -102,8 +111,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryKeyword.md index 8ecbfe3d9..b57a9fc5e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryKeyword.md @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site https://myserver/sites/engineering ``` @@ -44,6 +44,9 @@ This example gets a reference to the keyword with the term Engineering from the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the keyword term to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return keywords with the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScope.md index ae1c8aef7..3b634b8b1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScope.md @@ -42,7 +42,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPenterpriseSearchServiceApplication -Identity 'Search service Application' Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage https://altServer @@ -53,6 +53,9 @@ This example obtains a reference to the scope named MustCrawl on the search appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the results scope to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -60,8 +63,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,6 +73,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -78,8 +83,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -96,8 +103,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return scopes for the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -115,7 +124,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScopeRule.md index a2a1f18be..eb75f54bd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQueryScopeRule.md @@ -41,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -53,6 +53,9 @@ This example gets a reference to a scope rule for the URL https://criticalSite, ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. @@ -60,8 +63,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,6 +73,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns query scope rules for the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -79,7 +84,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid URL, in the form https://server_name. Returns query scope rules for the specified results URL. @@ -96,8 +103,7 @@ Returns query scope rules for the specified results URL. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -114,8 +123,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +133,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -132,8 +143,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySpellingCorrection.md index bf3988c2a..a7abc69f8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySpellingCorrection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySpellingCorrection.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchQuerySpellingCorrection -SearchApplication $ssa @@ -41,13 +41,15 @@ Returns the current configuration for the Query Spelling Correction component fo ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an object that represents the current status for the query spelling correction. ```yaml Type: QuerySpellingCorrectionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,13 +60,14 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the query spelling correction parameters. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -81,8 +87,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySuggestionCandidates.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySuggestionCandidates.md index 082de019a..3a6ad0c1a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySuggestionCandidates.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchQuerySuggestionCandidates.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE------------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchQuerySuggestionCandidates -SearchApplication $ssa @@ -42,6 +42,9 @@ This example returns popular search queries by using the search application cont ## PARAMETERS ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -55,7 +58,6 @@ The owner must be one of the following valid levels: Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -72,8 +77,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -90,8 +97,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,13 +107,15 @@ Accept wildcard characters: False ``` ### -SourceId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchRankingModel.md index c5b641633..0aa299984 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchRankingModel.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -41,7 +41,7 @@ Get-SPEnterpriseSearchRankingModel -Identity '8f6fd0bc-06f9-43cf-bbab-08c377e083 This example retrieves the ranking model on the search service application level with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 for the search application Search Service Application. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -53,6 +53,9 @@ This example retrieves all ranking models defined on the search service applicat ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ranking model to retrieve. The type must be a valid GUID in the form 8f6fd0bc-06f9-43cf-bbab-08c377e083f4, or an instance of a valid RankingModel object. @@ -60,8 +63,7 @@ The type must be a valid GUID in the form 8f6fd0bc-06f9-43cf-bbab-08c377e083f4, ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,6 +73,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -79,7 +84,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the ranking model. The type must be a valid GUID in the form 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -96,8 +103,7 @@ The type must be a valid GUID in the form 9bf36458-fc99-4f7b-b060-867e5a63adce, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -114,8 +123,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultItemType.md index e5a5efe51..cd9d88d5b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultItemType.md @@ -29,7 +29,7 @@ The Get-SPEnterpriseSearchResultItemType cmdlet retrieves the result item types Result item types enable you to change the look of search results based on the type of result. You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. +Then you define the display template to use for rendering that type of result. Once you have created the result item type, results matching the rules of the result item type will render using the specified display template. Example use cases: @@ -42,10 +42,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite @@ -59,6 +58,9 @@ Although SearchApplication and SearchApplicationProxy are optional parameters, t ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -66,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -100,8 +106,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -118,8 +126,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -136,8 +146,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultSource.md index 0fd9c0a26..66aca36fd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchResultSource.md @@ -30,10 +30,9 @@ This cmdlet retrieves a result source object. If the Identity parameter is not specified, this cmdlet returns the result source collection for the specified search object owner. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831] (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -------------- Example 1: Get result source by name -------------- +### -------------- Example 1: Get result source by name -------------- ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -42,8 +41,7 @@ Get-SPEnterpriseSearchResultSource -Identity "Local SharePoint Results" -SearchA This example retrieves the search service application level result source with the name "Local SharePoint Results". - -### -------------- Example 2: Get result source by id -------------- +### -------------- Example 2: Get result source by id -------------- ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -52,7 +50,7 @@ Get-SPEnterpriseSearchResultSource -Identity 8413cd39-2156-4e00-b54d-11efd9abdB8 This example retrieves the search service application level result source with the id 8413cd39-2156-4e00-b54d-11efd9abdB89. -### -------------- Example 3: Get all result sources under SSA -------------- +### -------------- Example 3: Get all result sources under SSA -------------- ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -64,6 +62,9 @@ This example retrieves all the search service application level result sources. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result source to retrieve. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Local SharePoint Results"); or an instance of a valid Source object. @@ -73,8 +74,7 @@ If not specified, the result source collection for the specified search object o ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -84,13 +84,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -107,8 +112,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -119,6 +123,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -126,8 +132,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSecurityTrimmer.md index d74a63b12..dd2404518 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSecurityTrimmer.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa @@ -44,6 +44,9 @@ This example obtains the pluggable security trimmers registered in the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the pluggable security trimmer used for the specified search application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. @@ -51,8 +54,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SecurityTrimmerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the security trimmer. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +94,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchService.md index 75a584323..edb1cb429 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchService.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchService ``` @@ -38,6 +38,9 @@ This example obtains a reference to the search service of the current farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplication.md index 49ce29d60..7f7f587a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplication.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' ``` @@ -39,6 +39,9 @@ This example obtains a reference to a search service application named 'Search S ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to retrieve. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationBackupStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationBackupStore.md index 9be408fbc..0acf82ace 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationBackupStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationBackupStore.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves information about the search service application backup files. - ## SYNTAX ``` @@ -33,17 +32,16 @@ This cmdlet returns information about the search databases and index files in a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -BackupId 3222ad97-91ad-471f-a764-780ec1f05f74 ``` This example retrieves the backup of the search databases and index files that are located at \\\\sample\backup with the backup id 3222ad97-91ad-471f-a764-780ec1f05f74 from the search service application Search Service Application. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -UseMostRecent ``` @@ -53,13 +51,15 @@ This example retrieves the most recently taken backup of the search databases an ## PARAMETERS ### -BackupFolder + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full file path of the backup files. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,15 +70,15 @@ Accept wildcard characters: False ### -Name -Specifies the name of the search service application from which to retrieve the related backup information. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the name of the search service application from which to retrieve the related backup information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -88,13 +88,15 @@ Accept wildcard characters: False ``` ### -BackupId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the backup in the referred package. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 4 @@ -104,13 +106,15 @@ Accept wildcard characters: False ``` ### -UseMostRecent + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A switch to specify if the most recent backup should be used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 5 @@ -120,13 +124,15 @@ Accept wildcard characters: False ``` ### -IsVerbose + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A switch to specify if messages should be printed out when the cmdlet is running. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 6 @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -147,8 +156,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -165,7 +176,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -175,6 +185,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -182,7 +195,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationProxy.md index 528d47c55..659045b08 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceApplicationProxy.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $proxy = Get-SPEnterpriseSearchServiceApplicationProxy -Identity 'Search Service Application Proxy' ``` @@ -40,6 +40,9 @@ This example obtains a reference to a search service application proxy with the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application proxy to retrieve. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -65,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceInstance.md index b2337dbb1..376c7d8a3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchServiceInstance.md @@ -29,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPEnterpriseSearchServiceInstance -Local ``` This example obtains a reference to the local search service instance. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPEnterpriseSearchServiceInstance | ?{$_.Server -match 'SP01'} ``` @@ -46,6 +46,9 @@ This example obtains a reference to the search service instance on the SharePoin ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance to return. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -53,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +76,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +86,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the search service instance for the current search server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSiteHitRule.md index 266bb0dc1..f0320c825 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchSiteHitRule.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$shRule = Get-SPEnterpriseSearchSiteHitRule -Identity MySiteHitRule ``` @@ -42,6 +42,9 @@ The following example obtains a reference to the site hit rule with the name MyS ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site hit rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SiteHitRule object. @@ -49,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SiteHitRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service that hosts the crawler with the specified shared site search rules. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -67,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchStatus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchStatus.md index e4dcfc5db..b137e183f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchStatus.md @@ -44,7 +44,7 @@ You can use the cmdlet to output the following additional information: - List detailed diagnostic information for the index component - Debug information that may be used by Microsoft for detailed issue resolution -If you don't want to iterate over the output in a script, use the Text parameter. +If you don't want to iterate over the output in a script, use the Text parameter. If you do not use the Text parameter, the cmdlet will output a set of objects that have the following properties: - string Name: the name of a search component, a health report item or a constellation property @@ -55,24 +55,23 @@ If you do not use the Text parameter, the cmdlet will output a set of objects th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -Text ``` This example retrieves a list that has diagnostics information about all search components of the default Search Service Application. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPEnterpriseSearchStatus -SearchApplication 'Search Service Application' -JobStatus -Text ``` This example retrieves the background activity job status for the search analytics timer jobs. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -HealthReport -Component IndexComponent1 -Text ``` @@ -82,13 +81,15 @@ This example retrieves the diagnostic information for the index component named ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -105,8 +109,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,16 +120,16 @@ Accept wildcard characters: False ### -Component -Specifies the name of the search component. -This parameter is only used in association with the HealthReport and Primary parameter. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the name of the search component. +This parameter is only used in association with the HealthReport and Primary parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,16 +140,16 @@ Accept wildcard characters: False ### -Constellation -Specifies if internal diagnostic information for the search topology should be provided. -This parameter should only be used for debugging. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies if internal diagnostic information for the search topology should be provided. +This parameter should only be used for debugging. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +159,16 @@ Accept wildcard characters: False ``` ### -Detailed + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the level of detail for the HealthReport parameter. When this parameter is used, the cmdlet will also output verbose diagnostic information. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,16 +179,16 @@ Accept wildcard characters: False ### -DetailSearchRuntime -Specifies if internal diagnostic information for the search runtime should be provided. -This parameter should only be used for debugging. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies if internal diagnostic information for the search runtime should be provided. +This parameter should only be used for debugging. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,16 +199,16 @@ Accept wildcard characters: False ### -HealthReport -Specifies if diagnostic information for the search component should be provided. -When using this parameter, you must specify the component name using the Component parameter. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies if diagnostic information for the search component should be provided. +When using this parameter, you must specify the component name using the Component parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +218,15 @@ Accept wildcard characters: False ``` ### -JobStatus + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if status information for the Search Analytics and Usage Analytics timer jobs should be provided. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -230,17 +237,17 @@ Accept wildcard characters: False ### -Primary +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the Admin component has the Primary role. -When using this parameter, you must specify the component name using the Component parameter. +When using this parameter, you must specify the component name using the Component parameter. Returns true if the Admin Component has the Primary role. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -251,18 +258,18 @@ Accept wildcard characters: False ### -Text -Specifies if the print output from this cmdlet should be outputted in a format that is convenient for reading. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies if the print output from this cmdlet should be outputted in a format that is convenient for reading. If not used, this cmdlet outputs a SearchStatusInfo object. When using this parameter, the output is printed to the console and cannot be piped to a file or another program. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchTopology.md index a0a3eef77..a998acb1c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchTopology.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -38,7 +38,7 @@ Get-SPEnterpriseSearchTopology -SearchApplication $ssa This example retrieves all search topologies of the search service application referenced by $ssa. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Active @@ -46,7 +46,7 @@ Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Active This example retrieves the active search topology of the search service application referenced by $ssa. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity '10fa59cb-4b32-4fe6-8f8d-065388df201e' @@ -57,13 +57,15 @@ This example retrieves search topology with the identity 10fa59cb-4b32-4fe6-8f8d ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology to retrieve. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -73,6 +75,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which the search topology belongs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -80,8 +85,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +95,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the active search topology should be returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,14 +113,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchVssDataPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchVssDataPath.md index e19a9625a..8d9d3211d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchVssDataPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPEnterpriseSearchVssDataPath.md @@ -23,17 +23,16 @@ Get-SPEnterpriseSearchVssDataPath [-AssignmentCollection Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +56,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBIServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBIServer.md index c71d66f10..a531d95b1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBIServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBIServer.md @@ -28,7 +28,7 @@ Use the Get-SPExcelBIServer cmdlet to return the server ID of the instance of An ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPExcelBIServer -ExcelServiceApplication 'Excel Service Application' ``` @@ -38,6 +38,9 @@ This example displays the name of the Excel Service application named 'Excel Ser ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013 + Specifies the ExcelServiceApplication identity. ```yaml Type: SPExcelBIServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBlockedFileType.md index b18ec5f87..9189f9169 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBlockedFileType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelBlockedFileType.md @@ -28,10 +28,9 @@ The Get-SPExcelBlockedFileType cmdlet reads a file type or a list of file types For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPExcelBlockedFileType -ExcelServiceApplication 'Excel Service Application' ``` @@ -41,6 +40,9 @@ This example retrieves all blocked file types for the service application named ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel @@ -67,8 +71,7 @@ Services Application Web service application in the farm (for example, MyExcelSe ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel @@ -86,8 +92,7 @@ Services Application Web service application in the farm (for example, MyExcelSe ```yaml Type: SPExcelBlockedFileTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataConnectionLibrary.md index b14881358..0dc2ca75f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataConnectionLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataConnectionLibrary.md @@ -24,21 +24,21 @@ Get-SPExcelDataConnectionLibrary [[-Identity] ] ``` ## DESCRIPTION -The Get-SPExcelDataConnectionLibrary cmdlet gets a library of data connection files that Excel Services Application and the Excel client use to connect to an external data source. +The Get-SPExcelDataConnectionLibrary cmdlet gets a library of data connection files that Excel Services Application and the Excel client use to connect to an external data source. Excel Services Application loads data connection files only if they are stored in a data connection library that is in the list of trusted data connection libraries. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelserviceapplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary ``` This example displays all the data connection libraries that connection files can be loaded by an Excel Services Application Web service application. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelserviceapplication -identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.Description.Contains("Sales Cube")} ``` @@ -48,6 +48,9 @@ This example displays all the data connection libraries that have descriptions c ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the DataConnectionLibrary object to return. If the identity parameter is not specified, this cmdlet returns all the data connection libraries that have connection files that can be loaded by Excel Services Application. @@ -56,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelDCLPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 1 @@ -67,6 +69,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -74,8 +79,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +103,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataProvider.md index 8e7789046..06167ed6f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelDataProvider.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE--------------------- +### EXAMPLE ``` Get-SPExcelServiceApplication -Identity "ExcelServices" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB"} ``` @@ -40,7 +40,7 @@ Get-SPExcelServiceApplication -Identity "ExcelServices" | Get-SPExcelDataProvide This example displays the data provider with the provider identifier (ID) SQLOLEDB from the list of data providers that is on the MyExcelService application. To select a specific provider from the list of safe providers, you must pipe a where clause that can filter the list of providers. -### --------------EXAMPLE-------------- +### EXAMPLE ``` Get-SPExcelDataProvider -ExcelServiceApplication "Excel Services" | format-table ``` @@ -50,6 +50,9 @@ This example displays a list of safe data providers for the specific Excel Servi ## PARAMETERS ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelDataProvider list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -57,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -68,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +84,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelFileLocation.md index c79deaf35..32889800b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelFileLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelFileLocation.md @@ -34,21 +34,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation ``` This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | Format-list * ``` This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService, and then formats the list of properties into a table. -### --------------EXAMPLE 3-------------- +### EXAMPLE 3 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | where {$_.ExternalDataAllowed -ne "None"} ``` @@ -58,6 +58,9 @@ This example displays a list of trusted file locations that allow external data ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelFileLocation object to return. If the Identity parameter is not specified, the cmdlet returns all the file locations in the specified. Excel Services Application Web service application. @@ -67,8 +70,7 @@ The type must be a valid string that identifies the file location, in the form h ```yaml Type: SPExcelFileLocationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 1 @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -85,8 +90,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -96,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelServiceApplication.md index 85e52ce77..40e4c7897 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelServiceApplication.md @@ -23,28 +23,28 @@ Get-SPExcelServiceApplication [[-Identity] ] ``` ## DESCRIPTION -The Get-SPExcelServiceApplication cmdlet retrieves an SPExcelServiceApplication object. +The Get-SPExcelServiceApplication cmdlet retrieves an SPExcelServiceApplication object. If the object returned by this cmdlet is changed, the change affects all instances of the specified Excel Services Application Web service application in the farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelServiceApplication "MyExcelServices" ``` This example displays the Excel Services Application Web service application named MyExcelServices. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication ``` This example displays every Excel Services Application Web service application that runs in the farm. -### --------------EXAMPLE 3-------------- +### EXAMPLE 3 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | format-list * ``` @@ -54,6 +54,9 @@ This example displays Excel Services Application Web service application named M ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the ExcelServiceApplication object to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -61,8 +64,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 1 @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelUserDefinedFunction.md index 08a9dbf39..948c01ca3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelUserDefinedFunction.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPExcelUserDefinedFunction.md @@ -24,7 +24,7 @@ Get-SPExcelUserDefinedFunction [[-Identity] ] ``` ## DESCRIPTION -The Get-SPExcelUserDefinedFunction cmdlet reads a user-defined function and its properties, or returns the collection of user-defined functions for an Excel Services Application Web service application. +The Get-SPExcelUserDefinedFunction cmdlet reads a user-defined function and its properties, or returns the collection of user-defined functions for an Excel Services Application Web service application. Excel Services Application uses only user-defined functions that are in the list of user-defined functions. User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. The assemblies can perform custom logic or other actions, such as refreshing data. @@ -34,14 +34,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf ``` This example displays the user-defined function named SampleCompany.SampleApplication.SampleUdf from the list of user-defined functions that is in the Excel Services Application Web service application named MyExcelService. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication | Get-SPExcelUserDefinedFunction | format-list ``` @@ -51,6 +51,9 @@ This example displays every user-defined function for every Excel Services Appli ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the UserDefinedFunction object to get. If the Identity parameter is not specified, the cmdlet returns all of the functions in the user defined functions list. @@ -59,8 +62,7 @@ The type must be a valid name of the code assembly (for example, SampleCompany.S ```yaml Type: SPExcelUDFPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 1 @@ -70,6 +72,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelUserDefinedFunction list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -77,8 +82,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +106,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md index 673213073..b650eb52f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the local SharePoint farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### +### ``` C:\PS>$f = Get-SPFarm ``` @@ -42,6 +41,9 @@ This example stores the local farm in a variable. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarmConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarmConfig.md index 3629d0fb2..4ae5e45dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarmConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarmConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a global property or a collection of global properties for the local farm. - ## SYNTAX ``` @@ -27,7 +26,7 @@ Get-SPFarmConfig [-AssignmentCollection ] [-ServiceConne ## DESCRIPTION The Get-SPFarmConfig cmdlet retrieves global settings for the local farm that are not members of the SPFarm object. -This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. +This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. The PSCustomObject object can be read, or modified and passed to the Set-SPFarmConfig cmdlet to change parameter values. @@ -39,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------------- +### EXAMPLE ``` $a = Get-SPFarmConfig $a.AjaxTimeout = 200 @@ -51,6 +50,9 @@ This example uses the Get-SPFarmConfig cmdlet to add the Ajax Timeout setting to ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -58,8 +60,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +70,15 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPoint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Gets the information stored in the current farm's service connection point in Active Directory. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFeature.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFeature.md index b466a842e..3e66259a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFeature.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFeature.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the SharePoint Features based on a given scope. - ## SYNTAX ### FarmFeatures @@ -68,13 +67,13 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPFeature -Limit ALL | Where-Object {$_.Scope -eq "SITE"} ``` This example returns a list of all installed SITE scoped Features. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPSite https://somesite | Get-SPWeb -Limit ALL |%{ Get-SPFeature -Web $_ } | Select DisplayName,ID -Unique ``` @@ -84,6 +83,9 @@ This example returns the name and identifier (ID) of each uniquely enabled Featu ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Feature to retrieve. The type must be the full or partial name, in the form Feature1, or a GUID, in the form 1234-4567-9879, of the Feature to get. @@ -91,8 +93,7 @@ The type must be the full or partial name, in the form Feature1, or a GUID, in ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -102,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -109,8 +113,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -Farm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that if this parameter is used, only enabled farm Features are displayed. ```yaml Type: SwitchParameter Parameter Sets: FarmFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits the display results. If "All" is specified, all Features are displayed. The type must be a valid number greater than 0. The default value is 200. @@ -143,8 +151,7 @@ The type must be a valid number greater than 0. The default value is 200. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the site collection from which to get enabled Features. The type must be a valid URL for a site collection, in the form https://server_name . @@ -161,8 +171,7 @@ The type must be a valid URL for a site collection, in the form https://server_n ```yaml Type: SPSitePipeBind Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the Web. The type must be a valid URL, in the form https://server_name , or a GUID, in the form 1234-5678-9876-0987. @@ -179,8 +191,7 @@ The type must be a valid URL, in the form https://server_name , or a GUID, in t ```yaml Type: SPWebPipeBind Parameter Sets: WebFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +201,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Web application from which to get enabled Features. The type must be a valid URL to the Web application in the form https://server_name . @@ -197,8 +211,7 @@ The type must be a valid URL to the Web application in the form https://server_n ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplicationFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: FarmFeatureDefinitions -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -Sandboxed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to retrieve Sandbox features. ```yaml Type: SwitchParameter Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHealthAnalysisRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHealthAnalysisRule.md index 9a1472b62..381bce555 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHealthAnalysisRule.md @@ -17,7 +17,6 @@ ms.reviewer: Gets a health analyzer rule. - ## SYNTAX ``` @@ -42,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ``` Get-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -52,6 +51,9 @@ This example returns the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or GUID of the health analyzer rule to get. The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -59,8 +61,7 @@ The type must be a valid name, an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHelpCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHelpCollection.md index 1e313094a..2333ac6bc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHelpCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPHelpCollection.md @@ -17,7 +17,6 @@ ms.reviewer: Returns Help collection files. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPHelpCollection ``` @@ -42,6 +41,9 @@ This example gets all installed Help collection files. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Help collection files to get. The type must be a valid name of a Help collection folder; for example, HelpDocs1. @@ -71,8 +75,7 @@ The type must be a valid name of a Help collection folder; for example, HelpDocs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPIRMSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPIRMSettings.md index c6e9fb229..ce110caa9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPIRMSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPIRMSettings.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE---------------- +### EXAMPLE ``` Get-SPIRMSettings ``` @@ -41,6 +40,9 @@ This example returns IRM settings for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormTemplate.md index 33006dbbc..c5ceaed66 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormTemplate.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPInfoPathFormTemplate ``` This example lists the Identity, DisplayName, and FormTemplateStatus property for each admininstrator-deployed InfoPath form template. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` C:\PS>"SomeFormTemplate.xsn" | Get-SPInfoPathFormTemplate | format-list ``` @@ -47,6 +47,9 @@ This example lists all the properties of the specified InfoPath form template. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormsService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormsService.md index d4b4fe678..951ad0b76 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormsService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathFormsService.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------------- +### EXAMPLE ``` Get-SPInfoPathFormsService ``` @@ -39,6 +39,9 @@ This example displays the InfoPath Forms Services settings for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath Forms Services settings to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -68,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathUserAgent.md index bd707e2e9..a3d3b790c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathUserAgent.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPInfoPathUserAgent ``` @@ -40,6 +40,9 @@ This example displays a list of user agents in the entire farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user agent to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUserAgentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathWebServiceProxy.md index 310bcc673..529d51c72 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathWebServiceProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInfoPathWebServiceProxy.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPInfoPathWebServiceProxy -Identity "https://server_name" ``` @@ -39,6 +39,9 @@ This example displays the Web service proxy settings for a specified Web applica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web application to get. The type must be a valid URL, in the form https://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -46,8 +49,7 @@ The type must be a valid URL, in the form https://server_name, or a valid GUID, ```yaml Type: SPWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInsightsConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInsightsConfig.md index 577648b0d..976d99c19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInsightsConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInsightsConfig.md @@ -26,7 +26,7 @@ Returns the uploader.xml and Microsoft.Office.BigData.DataLoader.exe.config file ## EXAMPLES -### Example 1 +### Example 1 ``` $config = Get-SPInsightsConfig $xml = $config.UploaderXml @@ -50,10 +50,12 @@ Start-SPService -Identity "Microsoft SharePoint Insights" This example returns and modifies the config.uploader.xml file. It then restarts the SharePoint Insights service on all servers in order to commit the changes. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -61,8 +63,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -95,7 +101,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateSyncLastRunTime.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateSyncLastRunTime.md index 5190d27ee..302c9b3ed 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateSyncLastRunTime.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateSyncLastRunTime.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the latest time the internal app state update job was invoked. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE----------- +### EXAMPLE ``` Get-SPInternalAppStateSyncLastRunTime ``` @@ -42,6 +41,9 @@ This example returns the latest time the internal app state update job was invok ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateUpdateInterval.md index 74a5a2aa2..6e9d47a09 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPInternalAppStateUpdateInterval.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the interval in hours between updates of the internal app state update job. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ``` Get-SPInternalAppStateUpdateInterval ``` @@ -42,6 +41,9 @@ This example returns the interval in hours between updates of the internal app s ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogEvent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogEvent.md index 16805192a..2ab86b2a8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogEvent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogEvent.md @@ -17,7 +17,6 @@ ms.reviewer: Returns results from a Unified Logging Service (ULS) trace log. - ## SYNTAX ### Directory @@ -47,42 +46,42 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPLogEvent -MinimumLevel "Warning" ``` This example returns all log entries equal to or more severe than Warning from the default log directory. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPLogEvent -Directory "C:\Logs" | Where-Object {$_.Level -eq "Warning"} ``` This example returns all warning entries from log files in the C:\Logs directory. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Get-SPLogEvent -StartTime "12/04/2007 17:00" -EndTime "12/04/2007 18:00" ``` This example returns error entries that occurred during a particular time range, which is culture-specific to the United States. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Get-SPLogEvent -ContextKey @("UserName" ,"SiteName") ``` This example returns the contents of the most recent log file and adds the specified context key data. -### --------------EXAMPLE 5----------------- +### EXAMPLE 5 ``` Get-SPLogEvent | Where-Object {$_.Level -eq "Error" -and {$_.Area -eq "SharePoint Foundation "} ``` This example returns all error entries related to SharePoint Foundation. -### --------------EXAMPLE 6----------------- +### EXAMPLE 6 ``` Get-SPLogEvent -ContextKey @("Name") | %{$_.ToString() + "'t" + $_.Context["Name"]} ``` @@ -92,6 +91,9 @@ This example returns the contents of the log file and adds context data. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +105,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,13 +115,15 @@ Accept wildcard characters: False ``` ### -AsString + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns each record as a separate string ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,13 +133,15 @@ Accept wildcard characters: False ``` ### -ContextKey + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that context data should be added to the results for the specified Context Keys, for example: `-ContextKey @("UserName", "SiteName")`. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,13 +151,15 @@ Accept wildcard characters: False ``` ### -Directory + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Lists log files from an alternate directory (any directory other than the configured LogLocation directory). ```yaml Type: String Parameter Sets: Directory -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +169,16 @@ Accept wildcard characters: False ``` ### -MinimumLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns records at or above the specified level. The valid values are Error or Warning. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,13 +188,15 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -195,13 +206,15 @@ Accept wildcard characters: False ``` ### -File + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a specific file to query records from. ```yaml Type: String Parameter Sets: File -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -211,13 +224,15 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogLevel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogLevel.md index ae087174b..f901cd4f6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogLevel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPLogLevel.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a list of objects or diagnostic levels. - ## SYNTAX ``` @@ -32,28 +31,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPLogLevel ``` This example displays throttle levels for all categories. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPLogLevel -Identity "Category1" ``` This example displays the throttle level for the Category1 category. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` C:\PS>"Cat1", "Cat2", "Cat3" | Get-SpLogLevel ``` This example displays the throttle level for multiple categories. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Get-SPLogLevel -Identity "Area:*" ``` @@ -63,6 +62,9 @@ This example displays the throttle level for all categories in one area. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid category name; for example, Backup and Restore, or Administration. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedAccount.md index e516cf2ca..5a714d3dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedAccount.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves accounts registered in the configuration database. - ## SYNTAX ### Server @@ -50,7 +49,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPManagedAccount ``` @@ -60,6 +59,9 @@ This example displays all the managed accounts in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -67,8 +69,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope to a server. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -Service + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope to a service. ```yaml Type: SPServicePipeBind Parameter Sets: Service -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope to a Web application. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedPath.md index 7d181a13d..461d642dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPManagedPath.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all managed paths that match the given criteria. - ## SYNTAX ### HostHeader @@ -37,7 +36,7 @@ This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). -The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. +The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. If an Identity parameter is not provided, all managed paths for the given scope are returned. Host-named sites (no matter the Web application in which they are contained) share a single set of managed paths. @@ -47,14 +46,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPManagedPath -WebApplication https://sitename ``` This example returns all managed paths for the specified Web application. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPManagedPath -identity "Sites" -HostHeader ``` @@ -64,6 +63,9 @@ This example gets the Sites managed path from the host-named site collections-sc ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the managed path to return. The type must be a valid URL, in the https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -71,8 +73,7 @@ The type must be a valid URL, in the https://server_name or a valid GUID (for ex ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If provided, the managed paths returned are for the host-named sites in the farm. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the Web application from which to get the managed path. The type must be a valid URL, in the form https://server_name, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -105,8 +111,7 @@ The type must be a valid URL, in the form https://server_name, or a valid GUID ( ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +135,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplication.md index 9757d0203..88d38cb75 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplication.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPMetadataServiceApplication -Identity "ManagedMetadataServiceApp1" ``` @@ -39,6 +39,9 @@ This example retrieves an existing managed metadata service application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed metadata service application to get. The type must be a valid GUID or the name of a valid managed metadata service application. @@ -46,8 +49,7 @@ The type must be a valid GUID or the name of a valid managed metadata service ap ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplicationProxy.md index af0f83c22..f3409ea75 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMetadataServiceApplicationProxy.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------- +### EXAMPLE ``` Get-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" ``` @@ -39,6 +39,9 @@ This example retrieves an existing connection to a managed metadata service appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application proxy to read. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMicrofeedOptions.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMicrofeedOptions.md index 510914a65..e25f20eff 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMicrofeedOptions.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMicrofeedOptions.md @@ -28,7 +28,7 @@ Returns the feed cache settings for the current user profile application. ## EXAMPLES -### Example 1 +### Example 1 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy @@ -39,6 +39,9 @@ This example returns cache feed settings from the specified User Profile Service ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMobileMessagingAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMobileMessagingAccount.md index f24ff99bb..830100a35 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMobileMessagingAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPMobileMessagingAccount.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves mobile messaging accounts for the specified Web application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPMobileMessagingAccount -WebApplication https://sitename ``` @@ -43,6 +42,9 @@ This example retrieves the current mobile account settings information of the We ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are:SMS and MMS. If you do not specify this parameter, account information is returned for both SMS and MMS. @@ -51,7 +53,6 @@ If you do not specify this parameter, account information is returned for both S Type: SPMobileMessagingAccountPipeBind Parameter Sets: (All) Aliases: ServiceType, AccountType -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). @@ -69,8 +73,7 @@ You either must specify WebApplication or must use the HostHeader switch and spe ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPO365LinkSettings.md index dd84bd826..72521eb1a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPO365LinkSettings.md @@ -38,6 +38,9 @@ This example returns all hybrid configurations. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSetting.md index 68366e8b3..d2475471a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSetting.md @@ -16,7 +16,6 @@ ms.reviewer: Returns Business Connectivity Services OData connection properties. - ## SYNTAX ``` @@ -34,36 +33,35 @@ You cannot use this command in the SharePoint Online Management Shell. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ``` Get-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp" ``` This example returns properties of the BCS connection named ContosoServiceApp -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ``` Get-SPODataConnectionSetting -ServiceContext "http://contoso" ``` This example returns a list of BCS connections for the service context named http://contoso - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -73,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,12 +82,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -96,14 +95,15 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the Business Connectivity Services connection object. +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + +Specifies the name of the Business Connectivity Services connection object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSettingMetadata.md index 2329fb9dd..776897d14 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSettingMetadata.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPODataConnectionSettingMetadata.md @@ -16,7 +16,6 @@ ms.reviewer: Returns a Business Data Connectivity service metadata object. - ## SYNTAX ``` @@ -32,29 +31,28 @@ You cannot use this command in the SharePoint Online Management Shell. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ``` Get-SPODataConnectionSettingMetadata -ServiceContext "http://contoso" -Name "ContosoServiceApp" ``` This example displays metadata properties of BCS connection named ContosoServiceApp - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -64,14 +62,15 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed. +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + +Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -81,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,12 +91,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPOfficeStoreAppsDefaultActivation.md index ce428fa0d..23066b5dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPOfficeStoreAppsDefaultActivation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPOfficeStoreAppsDefaultActivation.md @@ -16,7 +16,6 @@ ms.reviewer: Returns the properties of apps for Office. - ## SYNTAX ### AppsForOfficeSettingsInSiteSubscription @@ -40,17 +39,16 @@ Use the `Get-SPOfficeStoreAppsDefaultActivation` cmdlet to return settings for a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ``` Get-SPOfficeStoreAppsDefaultActivation -WebApplication https://sphvm-8044 ``` This examples returns the setting for the web application https://sphvm-8044. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ``` Get-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 ``` @@ -60,14 +58,15 @@ This examples returns the Subscription ID setting for the tenant ## PARAMETERS ### -SiteSubscription -Specifies the Site Group to which the settings apply. +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + +Specifies the Site Group to which the settings apply. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -77,14 +76,15 @@ Accept wildcard characters: False ``` ### -WebApplication -Specifies the URL, GUID, or name of the web application to which the setting applies. +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + +Specifies the URL, GUID, or name of the web application to which the setting applies. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -94,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,12 +105,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPendingUpgradeActions.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPendingUpgradeActions.md index 0bf84e638..0966371b6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPendingUpgradeActions.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPendingUpgradeActions.md @@ -17,7 +17,6 @@ ms.reviewer: Displays pending upgrade actions. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ``` Get-SPFarm | Get-SPPendingUpgradeActions -Recursive ``` @@ -40,6 +39,9 @@ Get-SPFarm | Get-SPPendingUpgradeActions -Recursive ## PARAMETERS ### -RootObject + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a SharePoint object where you check for which upgrade actions are outstanding for that object based on its current upgrade status. This object must be inherited from IUpgradable. @@ -47,8 +49,7 @@ This object must be inherited from IUpgradable. ```yaml Type: IUpgradable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -65,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +79,15 @@ Accept wildcard characters: False ``` ### -Recursive + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to perform the same pending upgrade action checks on each IUpgradable object that occurs under the RootObject parameter that is specified. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgradeActionInfo + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to not include pending upgrade actions for all child objects of a content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplication.md index bfab23da3..1b5ed89cc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplication.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPPerformancePointServiceApplication "PPSApp_01" ``` @@ -40,6 +40,9 @@ This example gets a PerformancePoint Service application named PPSApp_01. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplicationTrustedLocation.md index 8da26f935..278f60fbf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplicationTrustedLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPerformancePointServiceApplicationTrustedLocation.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------------EXAMPLE---------------------- +### EXAMPLE ``` Get-SPPerformancePointServiceApplication PPSApp_01 | Get-SPPerformancePointServiceApplicationTrustedLocation -Identity $_.ID | select * ``` @@ -41,6 +41,9 @@ This example retrieves TrustedLocation information for the PPSApp_01 Performance ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -70,7 +75,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted location to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPPerformancePointMonitoringServiceApplicationTrustedLocation object. @@ -87,8 +94,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application that contains the trusted location. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -105,8 +114,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPluggableSecurityTrimmer.md index 113355d20..0b10d61c5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPPluggableSecurityTrimmer.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ``` $pr = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id @@ -40,6 +40,9 @@ This example gets a list of the pluggable security trimmers that are associated ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the User Profile service application proxy to which the pluggable security trimmers have been added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProcessAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProcessAccount.md index 7393a4c15..794e44b26 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProcessAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProcessAccount.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a system account or a managed account. - ## SYNTAX ### LocalService @@ -47,14 +46,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Get-SPProcessAccount -NetworkService ``` This example creates the SPProcessAccountPipeBind type by using the NetworkService account. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPProcessAccount -NetworkService | New-SPServiceApplicationPool -Account $_ ``` @@ -64,6 +63,9 @@ This example creates an SPServiceApplicationPool account by using the NetworkSer ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,13 +87,15 @@ Accept wildcard characters: False ``` ### -LocalService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the LocalService account. ```yaml Type: SwitchParameter Parameter Sets: LocalService -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,13 +105,15 @@ Accept wildcard characters: False ``` ### -LocalSystem + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the LocalSystem account. ```yaml Type: SwitchParameter Parameter Sets: LocalSystem -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -NetworkService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the NetworkService account. ```yaml Type: SwitchParameter Parameter Sets: NetworkService -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProduct.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProduct.md index 04afb6975..5419b423d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProduct.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProduct.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. - ## SYNTAX ### Local @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPProduct -Local ``` @@ -54,6 +53,9 @@ This example displays the SharePoint-related products installed on the local ser ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +67,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,14 +77,16 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns product and update information for only the local computer. If you use the Local parameter, you cannot use the Server parameter. ```yaml Type: SwitchParameter Parameter Sets: Local -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +96,16 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns product and update information for a specified server. If you use the Server parameter, you cannot use the Local parameter. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileLeader.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileLeader.md index 29f14b252..00c927fe2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileLeader.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileLeader.md @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE----------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPProfileLeader -ProfileServiceApplicationProxy $proxy @@ -45,13 +45,15 @@ This example returns a company leader from the specific user profile service app ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,14 +87,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileServiceApplicationSecurity.md index e175f1114..c0bc83948 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProfileServiceApplicationSecurity.md @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} PS Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy -Type MySiteReaderACL @@ -46,13 +46,15 @@ This example displays MySite information on UPA Proxy 1. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -69,8 +74,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,14 +84,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of object to display. The type is any one of the following values: @@ -108,8 +117,7 @@ The type is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseQuota.md index 7665b8015..d52994add 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseQuota.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ``` ``` @@ -36,13 +36,15 @@ For permissions and the most current information about Windows PowerShell for Pr ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseUsage.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseUsage.md index 8b5c5d1b9..3c1bc9d6f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseUsage.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectDatabaseUsage.md @@ -26,7 +26,7 @@ Returns an approximate size, in megabytes (MB) of the Project Web App data used ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPProjectDatabaseUsage -Url https://contoso.com/sites/pwa ``` @@ -36,6 +36,9 @@ This example shows the size of the Project Web App data in the content data for ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the Project Web App site collection. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEnterpriseProjectTaskSync.md index 911d47043..5c69d6126 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEnterpriseProjectTaskSync.md @@ -27,7 +27,7 @@ Returns whether the task list sync between Project Web App and project sites is ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPProjectEnterpriseProjectTaskSync -Url https://contoso/sites/PWA ``` @@ -37,6 +37,9 @@ This example shows the syntax for getting the task sync status for the Project W ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEventServiceSettings.md index cbd2e3bdb..ba15e63e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectEventServiceSettings.md @@ -26,7 +26,7 @@ Returns the settings for the Microsoft Project Server Events Service. There is c ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPProjectEventServiceSettings ``` @@ -36,6 +36,9 @@ This example shows what port the service is listening on. ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectIsEmailNotificationEnabled.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectIsEmailNotificationEnabled.md index 79786c829..bd04d4928 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectIsEmailNotificationEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectIsEmailNotificationEnabled.md @@ -27,7 +27,7 @@ Returns the Project Web App site level setting for email notifications. True if ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPProjectIsEmailNotificationEnabled -Url https://contoso/sites/pwa ``` @@ -37,6 +37,9 @@ Returns the status of email notifications for the PWA site https://contoso/sites ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2016, Project Server 2019 + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectOdataConfiguration.md index 5ca29e115..ac8680662 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectOdataConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectOdataConfiguration.md @@ -22,7 +22,7 @@ Get-SPProjectOdataConfiguration [-AssignmentCollection ] ``` ## DESCRIPTION -The Get-SPProjectOdataConfiguration cmdlet returns the settings for how the OData service is configured for an instance of Project Web App. +The Get-SPProjectOdataConfiguration cmdlet returns the settings for how the OData service is configured for an instance of Project Web App. It returns the current settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled, and whether verbose errors are enabled. The cmdlet can also be used to return an itemized list of entities that have an override specified for their maximum page size. @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Get-SPProjectOdataConfiguration ``` This example returns the OData configuration for the instance of Project Web App. -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` C:\PS>(Get-SPProjectOdataConfiguration).EntitySetsWithMaxPAgeSizeOverride ``` @@ -47,6 +47,9 @@ This example returns the list of entities that have the MaxPageSizeOverride opti ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -58,8 +61,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPCSSettings.md index 806a30a5c..f2185b5a8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPCSSettings.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPProjectPCSSettings -sa "Project Service Application" ``` @@ -40,13 +40,15 @@ This example reads the settings for the Project Calculation Engine running on th ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Project Server Service Application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPermissionMode.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPermissionMode.md index 74d7a91e7..65bece3e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPermissionMode.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectPermissionMode.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ``` Get-SPProjectPermissionMode -Url https://AppServer/pwa ``` @@ -38,6 +38,9 @@ This example returns the permission mode setting for a PWA instance. ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the PWA instance for which you want to retrieve the permission mode. The type must be a valid URL, in the form https://\/\. @@ -45,8 +48,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectQueueSettings.md index 816146ac3..86acf6b19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectQueueSettings.md @@ -42,7 +42,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Get-SPProjectQueueSettings -ServiceApplication "Project Service Application" ``` @@ -52,6 +52,9 @@ This example retrieves the queue settings for the "Project Service Application" ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg; a valid name of a Project Server Service Application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -60,7 +63,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg; Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -70,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +86,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectWebInstance.md index 4e25d156b..48b4a1f5d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPProjectWebInstance.md @@ -41,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPProjectWebInstance -Url https://server/pwa ``` @@ -51,6 +51,9 @@ This example returns the properties for a Project Web App instance at https://se ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the name of the Project Server service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Web App instance (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -59,7 +62,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance to get. The type must be a valid URL, in the form https://\/\. @@ -98,8 +105,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRequestManagementSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRequestManagementSettings.md index f5386fc4e..c3e3ea440 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRequestManagementSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRequestManagementSettings.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a Request Manager object. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ``` Get-SPRequestManagementSettings -Identity ``` @@ -42,13 +41,15 @@ This example returns a request manager object for a specified identity. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the web-application for which a user wants to enable routing or throttling. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachineInfo.md index b2edf371b..4421a3149 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachineInfo.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all the routing targets. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------------ +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -47,13 +46,15 @@ This example returns a routing target for a specified identity. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not the specified computer will be available for routing. If no value is specified, all computers are returned. @@ -98,8 +104,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the computer for which you want to return routing information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachinePool.md index af81c182d..babdb4d90 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingMachinePool.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all available routing pools. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE--------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -46,13 +45,15 @@ This example returns a routing pool for the specified identity. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the machine pool to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingRule.md index d6327f372..4501b338e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPRoutingRule.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all routing rules. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------ +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -46,13 +45,15 @@ This example returns a routing rule for the farm. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the rule to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabase.md index 5b50ccd78..fde338b71 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all scale-out database objects. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" @@ -47,13 +46,15 @@ This example gets all scale-out databases for the given service application by u ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseDataState.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseDataState.md index 694e395f8..9a1db4836 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseDataState.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseDataState.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the state information about the specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -58,13 +57,15 @@ This example gets the data state of the scale-out database for the first scale-o ## PARAMETERS ### -ConnectionString + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection string for the scale-out database from which to return the state information. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to return the state information about. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +107,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the state information of the scale-out database is in the form of a Microsoft SQL Azure Database. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +164,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseInconsistency.md index 20513ff39..69767320b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseInconsistency.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseInconsistency.md @@ -17,7 +17,6 @@ ms.reviewer: Displays all inconsistencies related to scale-out databases' ranges. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" @@ -44,13 +43,15 @@ This example gets all the scale-out inconsistencies for the given service applic ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application for which to return the scale-out inconsistencies. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseLogEntry.md index fd4af6582..5b2985978 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseLogEntry.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPScaleOutDatabaseLogEntry.md @@ -17,7 +17,6 @@ ms.reviewer: Queries a scale-out database for scale-out logs. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE----------- +### EXAMPLE ``` C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -47,13 +46,15 @@ This example gets the 10 most recent scale-out log entries from the first scale- ## PARAMETERS ### -Count + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of scale-out log entries to return. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database from which to return the scale-out logs ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,14 +125,16 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the correlation id of the scale-out logs to be returned. Correlation id of the log entries that belong to the same major action are the same. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +144,9 @@ Accept wildcard characters: False ``` ### -MajorAction + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the major action of the scale-out log entries to be returned. The values are the following: @@ -145,8 +157,7 @@ Recovery -Any data recovery operation that is performed to recover from a failur ```yaml Type: SPScaleOutDatabaseMajorAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +168,8 @@ Accept wildcard characters: False ### -RangeLimitPoint +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the range limit point of the scale-out log entries to be returned. The range limit point has different meaning depending on the action that records the log entry. @@ -169,12 +182,10 @@ The range limit point has different meaning depending on the action that records --If the action extends the end point of the data range, range limit point represents the new end point of the data range. - ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -191,7 +205,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreApplication.md index 1c093657e..53158726a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreApplication.md @@ -40,14 +40,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" ``` This example gets the Secure Store application for the target application with the name ContosoTargetApplication. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPSecureStoreApplication -ServiceContext http://contoso -All ``` @@ -57,13 +57,15 @@ This example returns all of the Secure Store applications http://contoso. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Secure Store application to get. ```yaml Type: String Parameter Sets: NameSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for the local Secure Store application to connect to. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -96,8 +103,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +113,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns all secure store applications for the given Service Context. ```yaml Type: SwitchParameter Parameter Sets: AllSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreSystemAccount.md index 7b74ced1c..b1b86ad56 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecureStoreSystemAccount.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ``` Get-SPSecureStoreSystemAccount ``` @@ -38,6 +38,9 @@ This example returns a list of user accounts for the secure store system. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecurityTokenServiceConfig.md index a287826a3..dcffa194e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecurityTokenServiceConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSecurityTokenServiceConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the security token service (STS) for the farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPSecurityTokenServiceConfig -ServiceTokenLifetime 1000 ``` @@ -42,6 +41,9 @@ This example gets the security token service (STS) for the farm and sets the exp ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServer.md index 2d8794b0a..cbe86dbef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Returns the server or servers in the farm that match the given identity. - ## SYNTAX ``` @@ -31,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPServer ``` This example returns all servers in the local farm in a list. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPServer | Where{ $_.NeedsUpgrade -eq $TRUE} ``` @@ -48,13 +47,15 @@ This example returns a list of all servers in the farm that need an upgrade. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the address of the server to return. ```yaml Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabase.md index 8c04aff08..65f2ab156 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabase.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all scale-out database objects. - ## SYNTAX ``` @@ -34,10 +33,9 @@ For more information, see SharePoint Shared Service Database Scale Out Generic P - ## EXAMPLES -### ----------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" @@ -46,21 +44,20 @@ Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication This example gets all scale-out databases for the given service application by using the $serviceApplication variable. - ## PARAMETERS ### -ServiceApplication -Specifies the service application of the scale-out databases. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -71,6 +68,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,13 +80,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,17 +94,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,18 +115,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseDataState.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseDataState.md index 9b05d09f2..277bc5592 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseDataState.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseDataState.md @@ -18,7 +18,6 @@ Returns the state information about the specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -44,10 +43,9 @@ The database state information includes total count of partitions, total weight - ## EXAMPLES -### ----------------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication @@ -58,22 +56,20 @@ Get-SPServerScaleOutDatabaseDataState -Database $database This example gets the data state of the scale-out database for the first scale-out database of the given service application. - ## PARAMETERS ### -ConnectionString -Specifies the connection string for the scale-out database from which to return the state information. - +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the connection string for the scale-out database from which to return the state information. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,15 +80,15 @@ Accept wildcard characters: False ### -Database -Specifies the scale-out database for which the command returns state information. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the scale-out database for which the command returns state information. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +99,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,12 +111,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,15 +125,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,17 +144,16 @@ Accept wildcard characters: False ### -IsAzureDatabase -Specifies whether the state information of the scale-out database is in the form of a Microsoft Windows Azure SQL Database. - +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies whether the state information of the scale-out database is in the form of a Microsoft Windows Azure SQL Database. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,16 +164,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseInconsistency.md index 7a2a260e7..49096a530 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseInconsistency.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseInconsistency.md @@ -18,7 +18,6 @@ Displays all inconsistencies related to scale-out databases' ranges. - ## SYNTAX ``` @@ -32,10 +31,9 @@ Use the Get-SPServerScaleOutDatabaseInconsistency cmdlet to return all inconsist - ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ``` C:\PS>$serviceApplication = Get-SPServiceApplication -Name "AppManagement" @@ -48,16 +46,16 @@ This example gets all the scale-out inconsistencies for the given service applic ### -ServiceApplication -Specifies the service application for which to return the scale-out inconsistencies. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the service application for which to return the scale-out inconsistencies. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -68,6 +66,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,12 +78,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,16 +92,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,17 +112,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseLogEntry.md index cde6735a3..7837fbbc9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseLogEntry.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServerScaleOutDatabaseLogEntry.md @@ -17,7 +17,6 @@ ms.reviewer: Queries a scale-out database for scale-out logs. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Get-SPServerScaleOutDatabaseLogEntry -Count -Database $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication @@ -45,22 +43,20 @@ Get-SPServerScaleOutDatabaseLogEntry -Database $database -Count 10 -MajorAction This example gets the 10 most recent scale-out log entries from the first scale-out database of the given service application. - ## PARAMETERS ### -Count -Specifies the number of scale-out log entries to return. - +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the number of scale-out log entries to return. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -71,15 +67,15 @@ Accept wildcard characters: False ### -Database -Specifies the scale-out database from which to return the scale-out logs +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the scale-out database from which to return the scale-out logs ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +86,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,12 +98,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,18 +112,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -138,16 +133,16 @@ Accept wildcard characters: False ### -CorrelationId +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the correlation id of the scale-out logs to be returned. Correlation id of the log entries that belong to the same major action are the same. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +153,8 @@ Accept wildcard characters: False ### -MajorAction +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the major action of the scale-out log entries to be returned. The values are the following: @@ -167,12 +164,10 @@ Recovery -Any data recovery operation that is performed to recover from a failur - ```yaml Type: SPScaleOutDatabaseMajorAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,18 +178,18 @@ Accept wildcard characters: False ### -RangeLimitPoint +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the range limit point of the scale-out log entries to be returned. The range limit point has different meaning depending on the action that records the log entry. - ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,17 +200,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPService.md index 7369a0112..629a230a4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPService.md @@ -27,7 +27,7 @@ The Get-SPService cmdlet gets a service in the farm. ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPService -Identity 'Microsoft SharePoint Server Diagnostics Service' ``` @@ -37,13 +37,15 @@ This example gets the Microsoft SharePoint Server Diagnostics Service in the far ## PARAMETERS ### -All + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies all services in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -53,14 +55,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -70,13 +74,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service to get. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplication.md index 38ed0f6c5..506d8e02b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplication.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the specified service application. - ## SYNTAX ``` @@ -33,21 +32,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Get-SPServiceApplication ``` This example returns all service applications in the farm. -### ------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPServiceApplication -Identity e2c2be70-6382-4ce7-8a44-ae7dadff5597 ``` This example returns the service application that has the Identity "e2c2be70-6382-4ce7-8a44-ae7dadff5597". -### ------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ``` Get-SPServiceApplication -Name AccountingServiceApp ``` @@ -59,13 +58,15 @@ You can use either the Identity or the Name parameter but if you use both, the c ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application to get. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the friendly name of the new usage application.The type must be a valid name of a usage application; for example, UsageApplication1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationEndpoint.md index 6ab9e017a..3e532d69c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationEndpoint.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationEndpoint.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the endpoint of a service application. - ## SYNTAX ### Identity @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ``` Get-SPServiceApplicationEndpoint -ServiceApplication "ServiceSubApp1" ``` @@ -54,6 +53,9 @@ This example returns the SPServiceEndpoint object based on the specified service ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service endpoint to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form https://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. @@ -61,8 +63,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -79,8 +83,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +107,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application endpoint. The type must be a valid name of an service application endpoint; for example, SvcAppEndpoint1. @@ -119,8 +127,7 @@ The type must be a valid name of an service application endpoint; for example, S ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationPool.md index 83d157140..373ad969d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationPool.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the specified Internet Information Services (IIS) application pool. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPServiceApplicationPool ``` @@ -42,13 +41,15 @@ This example returns all the service application pools in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or identifier (ID) of the application pool to get. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxy.md index 414905e2b..c53aae9cc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxy.md @@ -17,7 +17,6 @@ ms.reviewer: Returns an instance of the specified service application proxy. - ## SYNTAX ``` @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPServiceApplicationProxy ``` @@ -46,13 +45,15 @@ This example retrieves all the service application proxies in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application proxy to return. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxyGroup.md index 9fb011fba..5281600ce 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationProxyGroup.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the proxy group for the specified service application. - ## SYNTAX ### Identity @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPServiceApplicationProxyGroup ``` @@ -51,13 +50,15 @@ This example retrieves all of the service application proxy groups in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or the GUID of the proxy group. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -67,13 +68,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the default service proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: Default identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +100,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationSecurity.md index 0b3fbe5f0..334d75eb5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceApplicationSecurity.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the SPObjectSecurity object for a service application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin Grant-SPObjectSecurity $security $principal "Full Control" @@ -46,6 +45,9 @@ The new user is an administrator for the service application $serviceApp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, SearchServiceApp1); or an instance of a valid SPServiceApplication object. @@ -53,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +65,15 @@ Accept wildcard characters: False ``` ### -Admin + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the access control list (ACL) that contains the administrators list of the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceContext.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceContext.md index aa90f16c6..a4ee66f69 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceContext.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceContext.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a service context. - ## SYNTAX ### Site @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ``` C:\PS>$sitesub = Get-SPSiteSubscription https://my.contoso.com/ @@ -56,6 +55,9 @@ This example returns the service context for a site in a hosted environment. ## PARAMETERS ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns the service context for only the Web application that contains the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -63,8 +65,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns all of the service contexts for all Web applications in which the specified site subscription has site collections. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -81,8 +85,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceHostConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceHostConfig.md index 5cf171817..d01e8f248 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceHostConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceHostConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the common Web service settings. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------- +### EXAMPLE ``` Get-SPServiceHostConfig ``` @@ -41,6 +40,9 @@ This example displays the Web service settings. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + This parameter has no effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceInstance.md index c3fc66e40..a3085e14d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPServiceInstance.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the services instance for a specific server or the entire farm. - ## SYNTAX ### Identity @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPServiceInstance -Server ServerA ``` @@ -54,6 +53,9 @@ This example displays the service instances from a given server. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service instance. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -61,8 +63,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceInstancePipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server from which to return the service instance. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -95,8 +101,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns all services instance in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSessionStateService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSessionStateService.md index aed1d96b3..d6d97f2f6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSessionStateService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSessionStateService.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPSessionStateService ``` @@ -38,6 +38,9 @@ This example returns the current configuration of the session state service. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPShellAdmin.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPShellAdmin.md index 150862887..910b85e4e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPShellAdmin.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPShellAdmin.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the names of all users who have the SharePoint_Shell_Access role. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE---------------------- +### EXAMPLE ``` Get-SPShellAdmin -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` @@ -42,14 +41,16 @@ This example returns the name of each user who has the SharePoint_Shell_Access r ## PARAMETERS ### -database + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the database or the Database Object that includes the SharePoint_Shell_Access role whose user names you want to display. If the database parameter is not specified, the configuration database is used. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSite.md index c6e78edde..c15c1be2c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSite.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all site collections that match the specified criteria. - ## SYNTAX ### AllSitesInIdentity @@ -75,21 +74,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Get-SPSite 'https://' | Get-SPWeb -Limit All | Select Title ``` This example gets the collection of subweb titles in site collection at https://\. -### ------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryOwner ``` This example gets a subset of data from all sites in the content database b399a366-d899-4cff-8a9b-8c0594ee755f. -### ------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Start-SPAssignment -Global @@ -106,7 +105,7 @@ The previous example uses the Global method of assignment collection. The Global method is easy to use but the contents of this object grows quickly. Be careful not to run a Get-SPSite command that returns many results while global assignment is enabled. -### ------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ``` $GC = Start-SPAssignment $Sites = $GC | Get-SPSite -Filter {$_.Owner -eq "DOMAIN\JDow"} -Limit 50 @@ -117,14 +116,14 @@ This example gets the first 50 sites owned by user DOMAIN\JDow by using a server This example uses advanced assignment collection methods. -### ------------------EXAMPLE 5--------------------- +### EXAMPLE 5 ``` Get-SPWebApplication https:// | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum} ``` This example shows a command that returns the sum of the disk space usage for all sites in a given web application. -### ------------------EXAMPLE 6--------------------- +### EXAMPLE 6 ``` Get-SPSite -Identity "https://localserver/(my|personal)/sites" -Regex ``` @@ -133,21 +132,21 @@ This example returns all sites that match the given regular expression. The Quotes on the Identity parameter are required when the Regex parameter is used. -### ------------------EXAMPLE 7--------------------- +### EXAMPLE 7 ``` Get-SPSite https:///sites/teams/* -Limit 100 ``` This example gets up to 100 of the sites under the URL https://sitename/sites/teams. -### ------------------EXAMPLE 8--------------------- +### EXAMPLE 8 ``` Get-SPSite | select url, @{Expression={$_.Usage.Storage}} ``` This example gets the amount of storage used by a site collection, by using the storage field of the .UsageInfo property. -### ------------------EXAMPLE 9--------------------- +### EXAMPLE 9 ``` Get-SPSite -Limit all -CompatibilityLevel 14 ``` @@ -157,6 +156,9 @@ This example returns all SharePoint Server mode site collections. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to get. The type must be a valid URL, in the form, https://server_name or https://server_name/sites/sitename, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -164,8 +166,7 @@ The type must be a valid URL, in the form, https://server_name or https://server ```yaml Type: SPSitePipeBind Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -175,6 +176,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name, in the form, SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -182,8 +186,7 @@ The type must be a valid database name, in the form, SPContentDB01, or a valid G ```yaml Type: SPContentDatabasePipeBind Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -193,6 +196,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription from which to get site collections. The type must be a valid URL, in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -200,8 +206,7 @@ The type must be a valid URL, in the form, https://server_name or a valid GUID ( ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -211,6 +216,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -218,8 +226,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +236,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be either SharePoint Server or SharePoint Server. @@ -237,8 +247,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -248,6 +257,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -255,7 +267,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -265,6 +276,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value in the form {$_PropertyName \ "filterValue"}. @@ -274,8 +288,7 @@ Valid operators are: EQ, NE, LIKE, NOTLIKE. ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -285,6 +298,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits the maximum number of site collections to return. The default value is 200. @@ -294,8 +310,7 @@ Specify ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -305,13 +320,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When used, the URL provided for the Identity parameter is treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -321,6 +338,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the web application from which to list sites. The type must be a valid URL, in the form, https://server_name, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the name of the web application (for example, WebApplication1212). @@ -328,8 +348,7 @@ The type must be a valid URL, in the form, https://server_name, a valid GUID (fo ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -339,6 +358,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -346,7 +368,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -356,6 +377,9 @@ Accept wildcard characters: False ``` ### -NeedsB2BUpgrade + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the site needs to be upgraded. The valid values are True and False. @@ -363,8 +387,7 @@ The valid values are True and False. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteAdministration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteAdministration.md index 5c5e16f77..370027ad1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteAdministration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteAdministration.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access. - ## SYNTAX ### AllSitesInIdentity @@ -58,7 +57,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage";Expression={$_.Quota.StorageMaximumLevel}} ``` @@ -66,7 +65,7 @@ Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage This example gets a subset of data from all of the sites in the content database with the URL b399a366-d899-4cff-8a9b-8c0594ee755f (farm administrator does not require access). This command uses the calculated property Storage to display the maximum storage value for the content database. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Start-SPAssignment -Global $s = Get-SPSiteAdministration -Identity https://MyApp/Sites/Site1 @@ -79,7 +78,7 @@ This example uses the Global method of garbage collection. This method is easier to use but grows quickly. Do not run a Get-SPSite command that returns many results while global assignment is on. -### ------------------EXAMPLE 3------------------- +### EXAMPLE 3 ``` C:\PS>$GC = Start-SPAssignment $Sites = $GC | Get-SPSiteAdministration -Filter {$_.Owner -eq "DOMAIN\JDoe"} -Limit 50 @@ -89,21 +88,21 @@ Stop-SPAssignment $GC This example gets the first 50 sites owned by user DOMAIN\JDoe by using a server-side query, and assigns the returned sites to a local variable. This command uses advanced assignment collection methods. -### ------------------EXAMPLE 4------------------ +### EXAMPLE 4 ``` Get-SPWebApplication https://sitename | Get-SPSiteAdministration -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.DiskUsed }{$sum} ``` This command returns the sum of the disk space usage for all sites in the specified Web application. -### ------------------EXAMPLE 5------------------ +### EXAMPLE 5 ``` Get-SPWebApplication https://sitename | Get-SPSiteAdministration -Limit ALL | Select URL ``` This example gets the URLs for all site collections in a Web application. -### ------------------EXAMPLE 6------------------ +### EXAMPLE 6 ``` Get-SPSiteAdministration -identity "https://localserver/(my|personal)/sites" -Regex ``` @@ -111,7 +110,7 @@ Get-SPSiteAdministration -identity "https://localserver/(my|personal)/sites" -Re This example returns all sites that match the given regular expression. The quotation marks around the value specified for the Identity parameter are required when using the Regex flag. -### ------------------EXAMPLE 7------------------ +### EXAMPLE 7 ``` Get-SPSite "https://sitename/sites/teams/*" -Limit 100 ``` @@ -121,6 +120,9 @@ This example gets up to 100 of the sites under the URL https://sitename/sites/te ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL (full or partial) or GUID of the site collection to retrieve. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-456-987fg. @@ -128,8 +130,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPSiteAdministrationPipeBind Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -139,6 +140,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL (full or partial) or GUID of the site collection to retrieve. The type must be a valid URL, in the form https://server_name, or a GUID, in the form, 1234-456-987fg. @@ -146,8 +150,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPContentDatabasePipeBind Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -157,6 +160,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site group from which to get site collections. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -164,8 +170,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -175,6 +180,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -186,8 +194,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +204,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -204,7 +214,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -214,6 +223,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the script block of the server-side filter to apply. The type must be a valid filter name and a value in the form { $_ PropertyName \ "filterValue"}} @@ -221,8 +233,7 @@ The type must be a valid filter name and a value in the form { $_ PropertyName \ ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -232,6 +243,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits the maximum number of site collections to return. The default value is 200. @@ -241,8 +255,7 @@ Provide ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,13 +265,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enabling this switch causes the URL provided for the Identity parameter to be treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +283,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL, in the form https://server_name; a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the Web application name (for example, WebApplication1212). @@ -275,8 +293,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID (for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -286,6 +303,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -293,7 +313,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMapDatabase.md index 850ce52d5..b21182856 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMapDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMapDatabase.md @@ -27,7 +27,7 @@ Do not use ## EXAMPLES -### Example 1 +### Example 1 ``` Do not use ``` @@ -37,13 +37,15 @@ Do not use ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -69,6 +73,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -76,7 +83,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMaster.md index 43f3c457a..cbfddecbb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteMaster.md @@ -41,7 +41,7 @@ Typically the following information is displayed: ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPSiteMaster -ContentDatabase WSS_Content ``` @@ -51,6 +51,9 @@ This example returns the site master in the database WSS_Content. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -58,8 +61,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +71,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to get the list of Site Masters. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscription.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscription.md index b06960415..24fc3f7df 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscription.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscription.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the site subscription for the given URL or all site subscriptions in the local farm. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE---------------------- +### EXAMPLE ``` C:\PS>$SiteSub = Get-SPSiteSubscription https://Contoso.com @@ -45,6 +44,9 @@ This example retrieves the site subscription for https://Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the subscription. The type must be a valid URL, in the form https://server_name. @@ -52,8 +54,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionConfig.md index 35a6c8633..bb5d134eb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the configuration properties of a site subscription. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ``` Get-SPSiteSubscriptionConfig https://contoso.com | Select FeatureSet ``` @@ -42,6 +41,9 @@ This example gets the feature set ID for the site subscription that contains the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription configuration to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoveryHub.md index 3481b2ee4..c69d7bcee 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoveryHub.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoveryHub.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE---------------------- +### EXAMPLE ``` Get-SPSiteSubscriptionEdiscoveryHub -Identity https://contoso.com ``` @@ -39,14 +39,16 @@ This example displays the eDiscovery hub for the specified site collection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the site collections to the eDiscovery hub. Can pipe the result from the Get-SPSiteSubscription cmdlet. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoverySearchScope.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoverySearchScope.md index 8568424ed..c97efad74 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoverySearchScope.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionEdiscoverySearchScope.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ``` Get-SPSiteSubscriptionEdiscoverySearchScope -Identity https://contoso.com ``` @@ -39,13 +39,15 @@ This example displays the search scope for the eDiscovery hub for the specified ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to the group of site collections that contained the search scope. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionFeaturePack.md index eb6c8244a..1d847e0a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionFeaturePack.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription. - ## SYNTAX ### FeaturePack @@ -45,14 +44,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get- SPSiteSubscriptionFeaturePack ``` This example returns all defined Feature sets in the local farm. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPSiteSubscriptionFeaturePack -SiteSubscription https://contoso.com | ForEach{ $_.FeatureDefinitions } ``` @@ -62,13 +61,15 @@ This example returns the list (name, ID, and scope) of all Features allowed in t ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid name or GUID of the Feature set. ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: FeaturePack -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If provided, ensures that the returned Feature set is the Feature set that is currently assigned to the given site subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionIRMConfig.md index 31d6ba643..8c9b0683e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionIRMConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionIRMConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Gets the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ``` site = Get-SPSite https://myspserver @@ -46,13 +45,15 @@ This example gets the IRM settings for a specified tenant by using the Identity ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription for a particular tenant. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionMetadataConfig.md index f7fe43d22..078859237 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteSubscriptionMetadataConfig.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` @@ -40,6 +40,9 @@ This example retrieves the site subscription-specific settings for an existing p ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription to read. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the metadata Service application for the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteURL.md index 2745b1520..949c72347 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteURL.md @@ -17,7 +17,6 @@ ms.reviewer: Displays all URL mappings for the site. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------- +### EXAMPLE ``` C:\PS>$site = Get-SPSite 'https://www.contoso.com' @@ -47,14 +46,16 @@ This example displays all the URLs that bind to the site collection, https://www ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to display. Must be the root site collection of a host name. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteUpgradeSessionInfo.md index aee51a921..68e347452 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteUpgradeSessionInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSiteUpgradeSessionInfo.md @@ -17,7 +17,6 @@ ms.reviewer: Manage or report site upgrade. - ## SYNTAX ### ContentDB @@ -46,7 +45,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ``` C:\PS>$db = Get-SPContentDatabase -Identity wss_content @@ -55,7 +54,7 @@ Get-SPSiteUpgradeSessionInfo -ContentDatabase $db This example returns siteupgradeinfo for every SPContentDatabase returned from Get-SPContentDatabase cmdlet. -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ``` C:\PS>$site=Get-SPSite -Identity https://localhost @@ -67,13 +66,15 @@ This example returns siteupgradeinfo for every SPSite object returned from Get-S ## PARAMETERS ### -ContentDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the content database from which to list site collections.The type must be a valid database name, in the form SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,11 +84,13 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -HideWaiting + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to hide site collections that upgrade has not started. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -ShowCompleted + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to show site collections that has completed upgrade. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -ShowFailed + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to show site collections that have failed upgrade. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -ShowInProgress + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays site collections that are in the process of being upgraded. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to limit the result to site collections within the site subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSolution.md index 96e6011e0..795cf6ff1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPSolution.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a specified SharePoint solution. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPSolution ``` @@ -43,6 +42,9 @@ This example returns the collection of all installed SharePoint solutions in the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint solution to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplication.md index 653e14c73..46e7cbafd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplication.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPStateServiceApplication ``` This example displays all state service applications in the farm. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPStateServiceApplication -Identity "StateServiceApp1" ``` @@ -47,6 +47,9 @@ This example displays a specific state service application in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to get. The type must be a valid name of a state service application (for example, StateServiceApp1) or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -55,7 +58,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +101,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplicationProxy.md index 05e2c73d2..02646b12e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceApplicationProxy.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPStateServiceApplicationProxy ``` This example displays all the state service application proxies on the farm. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPStateServiceApplicationProxy -Identity 81dc50e0-c0f9-4d2c-8284-bb03bb1ea676 ``` @@ -47,6 +47,9 @@ This example displays a specific state service application proxy on the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application proxy to get. The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -55,7 +58,6 @@ The type must be a valid name of a state service application proxy (for example, Type: SPStateServiceApplicationProxyPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +101,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceDatabase.md index ed2492fcb..ce6eb6fdd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPStateServiceDatabase.md @@ -41,21 +41,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1---------------- +### EXAMPLE 1 ``` Get-SPStateServiceDatabase ``` This example displays all of the state service databases on the farm. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example displays a specific state service database in the farm. -### --------------EXAMPLE 3-------------- +### EXAMPLE 3 ``` Get-SPStateServiceDatabase -ServiceApplication "StateServiceApp1" ``` @@ -65,6 +65,9 @@ This example displays all state service databases associated with a specific ser ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPStateServiceDatabase object (for example, StateSvcDB1). @@ -73,7 +76,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: Default Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return only the state service database associated with the specified state service application. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -91,7 +96,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: ServiceApplication Aliases: Application -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +119,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -140,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTaxonomySession.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTaxonomySession.md index 8263bd350..7bb4744aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTaxonomySession.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTaxonomySession.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ``` C:\PS>$session = Get-SPTaxonomySession -Site "https://sitename" ``` @@ -40,6 +40,9 @@ This example retrieves a TaxonomySession object, which can be used to access ter ## PARAMETERS ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint site mapped to the set of metadata term stores for the taxonomy session. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPThrottlingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPThrottlingRule.md index beba0b6f1..ead6466c2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPThrottlingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPThrottlingRule.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all throttling rules. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -46,13 +45,15 @@ This example returns throttling rules for the farm by using the $rm and $web var ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the throttling rule to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTimerJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTimerJob.md index b81bc8cd5..a19b68976 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTimerJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTimerJob.md @@ -31,14 +31,14 @@ If no parameters are specified, this cmdlet returns all timer job definitions fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### ---------------------EXAMPLE 01--------------------- +### EXAMPLE 01 ``` Get-SPTimerJob -WebApplication "https://servername" | select Name, DisplayName ``` This example displays all timer jobs for a specified Web application. -### ---------------------EXAMPLE 02--------------------- +### EXAMPLE 02 ```powershell Get-SPTimerJob | select -ExpandProperty HistoryEntries ``` @@ -47,6 +47,9 @@ The above example will show you timer job run history ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the timer job to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +91,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return timer jobs of a specified type. The type must be a name of a valid timer job type; for example, TimerJob1. @@ -94,8 +101,7 @@ The type must be a name of a valid timer job type; for example, TimerJob1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return timer jobs defined for the scope of a specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -112,8 +121,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplication.md index ab497cf3c..d2478415c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplication.md @@ -17,7 +17,6 @@ ms.reviewer: Displays properties of the topology service application for the current farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPTopologyServiceApplication ``` @@ -42,6 +41,9 @@ This example displays properties of the topology service application for the cur ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the application. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplicationProxy.md index 5fa2010e0..2f8cea115 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTopologyServiceApplicationProxy.md @@ -17,7 +17,6 @@ ms.reviewer: Retrieves the topology service application proxy. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPTopologyServiceApplicationProxy ``` @@ -42,6 +41,9 @@ This example displays the topology service application proxy in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the application proxy. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTranslationThrottlingSetting.md index 14e347588..918e44d26 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTranslationThrottlingSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTranslationThrottlingSetting.md @@ -23,11 +23,11 @@ Get-SPTranslationThrottlingSetting [-AssignmentCollection Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ``yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -Farm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the farm ```yaml Type: SPFarm Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -94,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedIdentityTokenIssuer.md index f5d678a37..6e3cac8fe 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedIdentityTokenIssuer.md @@ -17,7 +17,6 @@ ms.reviewer: Returns an identity provider. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ``` C:\PS>$trustedsts = Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" ``` @@ -42,6 +41,9 @@ This example gets a trusted identity token issuer. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedRootAuthority.md index 462aaf388..62edace43 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedRootAuthority.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a trusted root authority. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$rootauthority=Get-SPTrustedRootAuthority -Identity "WFEFarm1" ``` @@ -43,6 +42,9 @@ This example creates a new trusted root authority, WFEFarm1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted root authority to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedSecurityTokenIssuer.md index b79787e12..38ad74930 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedSecurityTokenIssuer.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the trusted security token issuer object. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ``` Get-SPTrustedSecurityTokenService ``` @@ -44,14 +43,16 @@ This example displays all trusted security token service objects from the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the trusted security token issuer object that you want to return. If you do not specify this parameter, the cmdlet returns all the objects. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedServiceTokenIssuer.md index 5d813d692..f45eefe2a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPTrustedServiceTokenIssuer.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the object that represents the farm trust. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPTrustedServiceTokenIssuer "WFEFarm1" ``` @@ -42,6 +41,9 @@ This example gets the trusted services token issuer WFEFarm1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted service token issuer to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUpgradeActions.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUpgradeActions.md index 6ceff3629..f2cc27ab1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUpgradeActions.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUpgradeActions.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all upgrade actions. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------ +### EXAMPLE ``` Get-SPUpgradeActions ``` @@ -41,6 +40,9 @@ This example returns all upgrade actions within the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageApplication.md index 7e6dd6691..08ad7fe0c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageApplication.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a specified usage application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPUsageApplication -Identity "Usage and Health data collection" ``` @@ -43,6 +42,9 @@ This example returns the usage application named, Usage and Health data collecti ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage application to get. If the Identity parameter is not specified, the cmdlet returns the local usage application. @@ -51,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -91,8 +97,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageDefinition.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageDefinition.md index 4913e94c4..6ebd5231d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageDefinition.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageDefinition.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a usage definition object. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPUsageDefinition -Identity "Page Requests" ``` @@ -44,6 +43,9 @@ This example returns the SPRequestUsage provider on the local farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage definition object to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. @@ -51,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageService.md index cf254636c..08ed188d9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUsageService.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a usage service. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE------------------------- +### EXAMPLE ``` Get-SPUsageService -Identity 57055d99-9914-4af6-a3bf-7b76e3f231c2 ``` @@ -43,6 +42,9 @@ This example returns a SPUsageService object of the specified ID. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage service to get. If the Identity parameter is not specified, the cmdlet returns the local usage service. @@ -51,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUser.md index 632a5d07f..88b71a91a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUser.md @@ -17,8 +17,7 @@ ms.reviewer: Returns the user account or accounts that match a given search criteria. - -## SYNTAX +## SYNTAX ``` Get-SPUser [[-Identity] ] -Web [-AssignmentCollection ] @@ -34,22 +33,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Get-SPUser -Web 'https://sharepoint.contoso.com' -Group 'Viewers' ``` This example returns all members of the SharePoint group Viewers on the site https://sharepoint.contoso.com. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPUser -Identity 'i:0#.w|contoso\jdoe' -Web 'https://sharepoint.contoso.com' ``` This example returns the specific user identified via Windows Claims on the site https://sharepoint.contoso.com. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Get-SPUser -Identity 'contoso\jdoe' -Web 'https://sharepoint.contoso.com' ``` @@ -59,6 +57,9 @@ This example returns the specific user identified via Classic Windows authentica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID or login name of the user to be returned. The type must be a valid ID or login name, such as the format of 'CONTOSO\jdoe' for Classic Windows Authentication or 'i:0#.w|CONTOSO\jdoe' for Windows Claims. @@ -67,7 +68,6 @@ The type must be a valid ID or login name, such as the format of 'CONTOSO\jdoe' Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -77,6 +77,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web site to be used as a scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Foundation Web site (for example, MySPSite1); or an instance of a valid SPWeb object. @@ -84,8 +87,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -95,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +111,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,13 +121,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user group to which the new user belongs. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +139,16 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of users to return. The default value is 500. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicense.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicense.md index 454888ad9..16619a92c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicense.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicense.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the list of supported SharePoint user licenses. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE------------------- +### EXAMPLE ``` Get-SPUserLicense ``` @@ -41,6 +40,9 @@ This example returns the list of supported SharePoint user licenses for the Shar ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicenseMapping.md index 8686488ca..d355055dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicenseMapping.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the claim-to-user license mappings. - ## SYNTAX ``` @@ -37,21 +36,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPUserLicenseMapping ``` This example returns all claim-to-user license mappings for the entire SharePoint farm. -### ---------------EXAMPLE 2 ----------------- +### EXAMPLE 2 ``` Get-SPUserLicenseMapping -WebApplication "SharePoint - 80" ``` This example returns all claim-to-user license mappings for the web application with the name "SharePoint - 80". -### ---------------EXAMPLE 3 ----------------- +### EXAMPLE 3 ``` Get-SPUserLicenseMapping -WebApplication https:///sitename ``` @@ -61,6 +60,9 @@ This example returns all claim-to-user license mappings for the Web application ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,14 +84,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, web application name, or instance of a web application object from which to get the user license mappings. The type must be an URL in the form https://server_name or https://server_name/sites/sitename, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh), a web application name (that is, SharePoint - 80), or an instance of a web application object. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicensing.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicensing.md index 9038d89df..f57ec3616 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicensing.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserLicensing.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the state of user-license enforcement. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ``` Get-SPUserLicensing ``` @@ -44,6 +43,9 @@ This example returns the state of user-license enforcement on the SharePoint far ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +57,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProvider.md index a531a5561..9abf4b6a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProvider.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a list of User Settings Providers installed on the farm. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE-------- +### EXAMPLE ``` C:\PS>$provider = Get-SPUserSettingsProvider @@ -52,13 +51,15 @@ This example returns the regional settings for a specified user. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID ID for a User Settings Provider. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +83,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProviderManager.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProviderManager.md index 9a0af2872..4dc2d648e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProviderManager.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSettingsProviderManager.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the User Settings Provider Manager. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ``` Get-SPUserSettingsProviderManager ``` @@ -41,6 +40,9 @@ This example returns the User Settings Provider Manager for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolution.md index 812f3182f..6ae23f9a5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolution.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a specified sandboxed solution. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE--------------------- +### EXAMPLE ``` Get-SPUserSolution -Site https://sitename ``` @@ -44,6 +43,9 @@ This example displays information about sandboxed solutions in the site https:// ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution to get. The type must be a valid name of a user solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -51,8 +53,7 @@ The type must be a valid name of a user solution (for example, UserSolution1); o ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection that contains the sandboxed solution. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -69,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolutionAllowList.md index a7819dda6..5c4231b9f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPUserSolutionAllowList.md @@ -27,7 +27,7 @@ Gets the user managed solutions gallery configured on the specified web applicat ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPUserSolutionAllowList -WebApplication https://webAppUrl ``` @@ -36,6 +36,9 @@ This example gets the user managed solutions gallery on the web application with ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -70,13 +74,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the web application to search for the user solution allow list. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +92,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +102,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioExternalData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioExternalData.md index 40566241a..59b94d16e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioExternalData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioExternalData.md @@ -29,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ``` Get-SPVisioExternalData -VisioServiceApplication "VGS1" ``` This example gets settings related to external data for a Visio Services application. -### ------------------EXAMPLE 2------------------------ +### EXAMPLE 2 ``` Get-SPVisioServiceApplication -identity "VGS1" | Get-SPVisioExternalData ``` @@ -46,6 +46,9 @@ This example uses a pipe bind to get settings related to external data for a Vis ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioExternalData object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -53,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioPerformance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioPerformance.md index 54be97aaf..8c2dcf289 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioPerformance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioPerformance.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------------- +### EXAMPLE ``` Get-SPVisioPerformance -VisioServiceApplication "VGS1" ``` @@ -39,6 +39,9 @@ This example gets settings related to performance for a Visio Services applicati ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioPerformance object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioSafeDataProvider.md index a060a5326..13b4c577d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioSafeDataProvider.md @@ -31,14 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" ``` This example returns a list of safe data providers for a specific Visio Services application. -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 ``` @@ -48,6 +48,9 @@ This example returns information about a specified safe data provider for a spec ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -55,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -DataProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the safe data provider to get. The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Graphics Service application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -97,8 +104,7 @@ The type must be a valid string that identifies the data provider; for example, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +114,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the supported type of the data provider to get. Custom data types are supported; for example, Excel services. @@ -116,8 +125,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplication.md index 379327d7b..2836032dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplication.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1------------------------- +### EXAMPLE 1 ``` Get-SPVisioServiceApplication ``` This example returns a collection of all Visio Services applications in the farm. -### -----------------------EXAMPLE 2------------------------- +### EXAMPLE 2 ``` Get-SPVisioServiceApplication "VGS1" ``` @@ -47,6 +47,9 @@ This example returns properties of the VGS1 Visio Services application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplicationProxy.md index 06510cd32..94c8dc34c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPVisioServiceApplicationProxy.md @@ -30,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Get-SPVisioServiceApplicationProxy ``` This example returns a list of Visio Services application proxies. -### ----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Get-SPVisioServiceApplicationProxy "Connection to VGS2" ``` @@ -47,6 +47,9 @@ This example returns settings for a Visio Services application proxy. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application proxy to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +81,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIBinding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIBinding.md index 17856cf1c..f7bcfb8d3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIBinding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIBinding.md @@ -17,7 +17,6 @@ ms.reviewer: Returns a list of bindings that were created by using New-SPWOPIBinding on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -33,14 +32,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPWOPIBinding -Server "Server.corp.Contoso.com" ``` This example returns a list of bindings that were created on the current SharePoint farm where this cmdlet is run for the WOPI application "Server.corp.Contoso.com." The WOPI application may be the server that runs Office Web Apps Server. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPWOPIZone | Get-SPWOPIBinding ``` @@ -50,13 +49,15 @@ This example returns a list of bindings that were created on the current SharePo ## PARAMETERS ### -Action + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the action to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extension to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the programmatic identifier (ProgID) for an application to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of WOPI application (such as a server that runs Office Web Apps Server) to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -WOPIZone + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the zone to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPISuppressionSetting.md index b692e4610..28f1253e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPISuppressionSetting.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the suppression settings on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPWOPISuppressionSetting ``` @@ -42,6 +41,9 @@ The suppression settings returned include the DocType and WOPIAction. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIZone.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIZone.md index b32a5c361..32bd1312e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIZone.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWOPIZone.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the zone that is configured on the current SharePoint farm for the WOPI application to use. - ## SYNTAX ``` @@ -31,17 +30,20 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPWOPIZone ``` -This example returns the zone that is configured for the WOPI application (such as a server that runs Office Web Apps Server) to use. +This example returns the zone that is configured for the WOPI application (such as a server that runs Office Web Apps Server) to use. Return values may be "internal-http," "internal-https," "external-http" or "external-https." ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWeb.md index 3b1ed5ee3..231ff2dea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWeb.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all subsites that match the given criteria. - ## SYNTAX ``` @@ -36,7 +35,7 @@ The Identity parameter also supports providing a partial URL that ends in a wild All subsites that match this partial URL for the specified scope are returned. Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any subweb with a URL provided in the given scope that matches the expression is returned. -The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. +The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. These subsite properties are Template and Title. The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run server-side for faster results. @@ -47,21 +46,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Get-SPWeb -site https://sitename/sites/site1 ``` This example returns all the subwebs in a given site collection. -### --------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPWeb -Site https://sitename/sites/site1 -filter {$_.Template -eq "STS#0"} ``` This example displays all subsites that use the "STS#0" template. -### --------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ``` Start-SPAssignment -Global @@ -79,6 +78,9 @@ This example demonstrates how to save a subsite as a variable and to call object ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or full or partial URL of the subsite. If you use a relative path, you must specify the Site parameter. @@ -87,8 +89,7 @@ A valid URL in the form https://server_name or a relative path in the form of /S ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -98,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server-side filter to use for the specified scope. The type must be a valid filter in the form {filterName \ "filterValue"}. @@ -144,8 +152,7 @@ The type must be a valid filter in the form {filterName \ "filterValu ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +162,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits the maximum number of subsites to return. The default value is 200. To return all sites, enter ALL @@ -164,8 +174,7 @@ The type must be a valid number greater than 0 or ALL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +184,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL that is provided by the Identity parameter is treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection from which to list subsites. The type must be a valid URL, in the form of https://server_name; a GUID, in the form 1234-5678-9807, or an SPSite object. @@ -198,8 +212,7 @@ The type must be a valid URL, in the form of https://server_name; a GUID, in th ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -216,7 +232,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplication.md index 1e176e7a6..b37eb4a74 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplication.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all Web applications that match the given criteria. - ## SYNTAX ``` @@ -36,14 +35,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` C:\PS>$w = Get-SPWebApplication https://sitename ``` This example gets the Web application for https://sitename and stores it in a variable. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPWebApplication -IncludeCentralAdministration | Where { $_.DefaultServerComment -eq "SharePoint Central Administration v4"} | Format-List * ``` @@ -53,6 +52,9 @@ This example displays all public properties on the SharePoint Central Administra ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name, URL, or GUID of the Web application. The type must be a valid URL, in the form https://server_name; a GUID, in the form 1234-5678-9876-0987; or a valid name, in the form SPWebApplication - 1212. @@ -60,8 +62,7 @@ The type must be a valid URL, in the form https://server_name; a GUID, in the fo ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +86,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +96,16 @@ Accept wildcard characters: False ``` ### -IncludeCentralAdministration + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Includes the Central Administration Web application in the collection of Web applications that can be returned. The IncludeCentral Administration parameter must still meet any other filters provided. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationAppDomain.md index a9286f33e..835bce36d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationAppDomain.md @@ -38,28 +38,28 @@ Use the Get-SPWebApplicationAppDoman cmdlet to return all app domains for a spec ## EXAMPLES -### -----------EXAMPLE 1--------- +### EXAMPLE 1 ``` Get-SPWebApplicationAppDomain ``` Returns a list of SPAppDomain objects, one for each of the app domains for all web applications in the farm. -### -----------EXAMPLE 2--------- +### EXAMPLE 2 ``` Get-SPWebApplicationAppDomain -Zone Default ``` Returns a list of SPAppDomain objects, one for each of the app domains for the Default zone for all web applications in the farm. -### -----------EXAMPLE 3--------- +### EXAMPLE 3 ``` Get-SPWebApplicationAppDomain -WebApplication https://www.contoso.com ``` Returns a list of SPAppDomain objects, one for each of all the app domains for the specified web application for all zones. -### -----------EXAMPLE 4--------- +### EXAMPLE 4 ``` Get-SPWebApplicationAppDomain -AppDomain contosoapps.com ``` @@ -70,13 +70,14 @@ Returns a list of SPAppDomain objects, one for each web application and zone pai ### -Identity +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object. ```yaml Type: SPAppDomainPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -87,13 +88,14 @@ Accept wildcard characters: False ### -AppDomain +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the app domain. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,13 +106,14 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID, URI, or name of the web application for which the app domain is being configured. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,6 +124,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -128,8 +133,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +144,8 @@ Accept wildcard characters: False ### -Zone +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the security zone to which the app domain will be assigned. * Default @@ -157,8 +163,7 @@ If no value is specified, Default is applied. ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationHttpThrottlingMonitor.md index 4915ccf65..cd402e131 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationHttpThrottlingMonitor.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebApplicationHttpThrottlingMonitor.md @@ -17,7 +17,6 @@ ms.reviewer: Returns all counters and their associated Health Score bucket values for network throttling on a Web application. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$s = get-SPWebApplicationHTTPThrottlingMonitors https://sharepoint ``` @@ -43,6 +42,9 @@ This example gets all performance counters that are being read in the network th ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns throttling performance counter settings for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebPartPack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebPartPack.md index 47eb12296..2c4248f58 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebPartPack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebPartPack.md @@ -17,7 +17,6 @@ ms.reviewer: Returns the Web Part packages that were installed for the specified scope. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPWebPartPack -WebApplication http://zsharepoint2:80 ``` @@ -45,6 +44,9 @@ This example returns all Web Part packages that have been installed on the Web a ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full or partial name of the Web Part package from the configuration database. The type must be a valid name of a Web Part package; for example, MyWebPartPackage. @@ -52,8 +54,7 @@ The type must be a valid name of a Web Part package; for example, MyWebPartPacka ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -GlobalOnly + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns only Web Part packages that are installed in the global assembly cache (GAC). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,14 +106,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application from which to list Web Part packages. If no Web application is specified, the specified Web Part packages will be returned from all Web applications. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplate.md index c8099954a..fc8ae69a4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplate.md @@ -17,7 +17,6 @@ ms.reviewer: Displays all globally installed site templates that match the given identity. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` C:\PS>$template = Get-SPWebTemplate "STS#0" @@ -41,7 +40,7 @@ New-SPSite https://contoso.com -OwnerAlias "DOMAIN\JDOE" -Template $template This example creates a site collection by using the team site Web template (ID=STS#0). -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPWebTemplate "STS*" ``` @@ -51,6 +50,9 @@ This example displays basic information about all the STS templates. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Web template to display. The type must be the ID or full or partial name of the Web template. @@ -58,8 +60,7 @@ The type must be the ID or full or partial name of the Web template. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -69,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +84,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be either SharePoint Server or SharePoint Server. @@ -99,8 +105,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplatesEnabledForSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplatesEnabledForSiteMaster.md index 633c01ff9..2049be4fa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplatesEnabledForSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWebTemplatesEnabledForSiteMaster.md @@ -26,7 +26,7 @@ Use the Get-SPWebTemplatesEnabledForSiteMaster cmdlet to display a full list of ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPWebTemplatesEnabledForSiteMaster ``` @@ -36,6 +36,9 @@ This example displays all the site master web templates in a farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowConfig.md index a7a28ef96..12e2a8b42 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowConfig.md @@ -17,7 +17,6 @@ ms.reviewer: Returns workflow settings for the specified Web application. - ## SYNTAX ### SiteCollection @@ -43,7 +42,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPWorkFlowConfig -webapplication https://sitename ``` @@ -55,6 +54,9 @@ To get farm-level workflow settings for event delivery time-out, postpone thresh ## PARAMETERS ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or URL of the site collection. The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. @@ -63,8 +65,7 @@ No other parameters are used. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or URL of the Web application. The type must be a valid name, in the form WebApplication-1212, or a URL, in the form https://server_name/WebApplication-1212. @@ -81,8 +85,7 @@ The type must be a valid name, in the form WebApplication-1212, or a URL, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowServiceApplicationProxy.md index fe4e59f17..6e06800db 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPWorkflowServiceApplicationProxy.md @@ -27,7 +27,7 @@ Returns the Workflow Service Application Proxy. ## EXAMPLES -### Example 1 +### Example 1 ``` Get-SPWorkflowServiceApplicationProxy ``` @@ -36,6 +36,9 @@ Returns the Workflow Service Application Proxy. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -70,6 +74,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -77,7 +84,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPBusinessDataCatalogMetadataObject.md index 712a16af5..9c327b9d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPBusinessDataCatalogMetadataObject.md @@ -17,7 +17,6 @@ ms.reviewer: Grants a right to a principal for the specified Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName $Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -ServiceContext http://contoso -Name "ContosoModel" @@ -46,13 +45,15 @@ This example gives Edit permissions to the user with the identity johndoe on dom ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the principal to whom the rights apply. The type must be a claim. @@ -69,8 +73,7 @@ The type must be a claim. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the right to grant the principal. The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. @@ -87,8 +93,7 @@ The type must be one of the following valid PSBdcRight object types: All, Execut ```yaml Type: PSBdcRight Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the model slice for which to grant the right. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -144,8 +156,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +166,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +176,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPObjectSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPObjectSecurity.md index 39d8619da..880f17a67 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPObjectSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Grant-SPObjectSecurity.md @@ -17,7 +17,6 @@ ms.reviewer: Adds a new security principal to an SPObjectSecurity object. - ## SYNTAX ``` @@ -33,9 +32,9 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -$principal = New-SPClaimsPrincipal "CONTOSO\JaneDoe" -IdentityType WindowsSamAccountName +$principal = New-SPClaimsPrincipal "CONTOSO\JaneDoe" -IdentityType WindowsSamAccountName $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} $security = Get-SPServiceApplicationSecurity $sa -Admin Grant-SPObjectSecurity $security $principal "Full Control" @@ -49,14 +48,16 @@ The new user is an administrator for the service application $serviceApp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPObjectSecurity object to which the new security principal is added. You can use the Get-SPServiceApplicationSecurity cmdlet to get a SPObjectSecurity object . ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the principal to whom the rights apply. The type must a valid name a principal; for example, Full Control. @@ -73,8 +77,7 @@ The type must a valid name a principal; for example, Full Control. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Rights + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the rights granted to the principal. The type must a valid array of strings that represents the rights granted to the principal. @@ -91,8 +97,7 @@ The type must a valid array of strings that represents the rights granted to the ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 3 @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +121,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,14 +131,16 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Replaces the existing rights on the SPObjectSecurity object with the new rights specified. If this parameter is not specified, the new rights are added to the existing rights. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAccessServicesDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAccessServicesDatabase.md index d039f4aee..be0613ac9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAccessServicesDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAccessServicesDatabase.md @@ -7,7 +7,7 @@ title: Import-SPAccessServicesDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPAccessServicesDatabase @@ -33,7 +33,7 @@ See more information about Data-Tier Framework at [Data-tier Applications](https ## EXAMPLES -### Example 1 +### Example 1 ``` $accessDb = Get-SPAccessServicesDatabaseServer -ServiceContext http://site_url -DatabaseServer SQLSERVERNAME -DatabaseServerGroup DEFAULT Import-SPAccessServicesDatabase -DatabaseName accessDatabaseName -ServerReferenceId $accessDb.ServerReferenceId -Bacpac (Get-Content -Path C:\accessDb.bacpac -Encoding Byte) @@ -44,6 +44,9 @@ This example gets the ServerReferenceId value of the SQL Server for the Access S ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Bacpac + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + A byte array of the bacpac file. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The name of the database to create from the bacpac file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,13 +100,15 @@ Accept wildcard characters: False ``` ### -ServerReferenceId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The ServerReferenceId to be used for the Access Database. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAppPackage.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAppPackage.md index 6d05ac9a3..cc9594e19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAppPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPAppPackage.md @@ -7,7 +7,7 @@ title: Import-SPAppPackage schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPAppPackage @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------- +### EXAMPLE ``` Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) ``` @@ -40,13 +40,15 @@ This example imports an app package. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of the input file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines the source of the app. The source indicates where the app package originates from, for example, if the app was built by a developer but did not reside on the SharePoint Marketplace, you might use the CorporateCatalog source. The following are valid values: @@ -69,13 +74,11 @@ The following are valid sources (not parameters of -Source) of the app: --App catalog (CorporateCatalog) --SharePointService - Indicates apps that were built in place with SharePoint features, for example Access Services (ObjectModel) - ```yaml Type: SPAppSource Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +141,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -AssetId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Asset Id to import. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +168,15 @@ Accept wildcard characters: False ``` ### -ContentMarket + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the content market. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,13 +186,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPSite object to import. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogDotNetAssembly.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogDotNetAssembly.md index c7ce2d336..9e90cfe60 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogDotNetAssembly.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogDotNetAssembly.md @@ -7,7 +7,7 @@ title: Import-SPBusinessDataCatalogDotNetAssembly schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPBusinessDataCatalogDotNetAssembly @@ -17,7 +17,6 @@ ms.reviewer: Imports a .NET Connectivity assembly. - ## SYNTAX ``` @@ -33,14 +32,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1---------------- +### EXAMPLE 1 ``` Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" ``` This example imports the assembly Assembly. -### -----------------EXAMPLE 2---------------- +### EXAMPLE 2 ``` Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" -DependentAssemblyPaths "c:\Folder\Assembly2.dll","c:\Folder\Assembly3.dll" ``` @@ -50,13 +49,15 @@ This example imports the assembly Assembly, and also imports the dependent assem ## PARAMETERS ### -LobSystem + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the LobSystem that the assembly corresponds to. ```yaml Type: LobSystem Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path to the primary assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,13 +128,15 @@ Accept wildcard characters: False ``` ### -DependentAssemblyPaths + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a list of paths to dependent assemblies. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogModel.md index 8ab8f9959..a19edf506 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPBusinessDataCatalogModel.md @@ -7,7 +7,7 @@ title: Import-SPBusinessDataCatalogModel schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPBusinessDataCatalogModel @@ -43,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$MetadataStore = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Catalog" -ServiceConext https://contoso Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $MetadataStore @@ -51,7 +51,7 @@ Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $Metada This example gets the Business Data Connectivity Metadata Store and then imports a Business Data Connectivity Model of Model type to it from the path specified with the name model. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Import-SPBusinessDataCatalogModel -Path "C:\Program Files\Duet Enterprise\2.0\BDC Models\Reporting.en-us.bdcr -Identity $bdcCatalog -ModelsIncluded:$false ``` @@ -61,13 +61,15 @@ This example imports a resource only file by using the ModelsIncluded parameter. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object to import to. ```yaml Type: MetadataObject Parameter Sets: Catalog -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +79,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name to use. The type must be a valid path in either of the following forms: @@ -88,8 +93,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -138,13 +146,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the Business Data Connectivity Model if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +164,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that names for business data fields in multiple languages are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +182,16 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that models are included in the imported Business Data Connectivity Model file. A model contains the base XML metadata for a system. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +201,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that permissions from the Business Data Connectivity Model are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +219,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that properties from the Business Data Connectivity Model are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +237,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom environment settings model slice to import. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -226,8 +247,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +257,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -244,7 +267,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -254,13 +276,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context to set. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchCustomExtractionDictionary.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchCustomExtractionDictionary.md index 0f4c2ff05..8b0d834e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchCustomExtractionDictionary.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchCustomExtractionDictionary.md @@ -7,7 +7,7 @@ title: Import-SPEnterpriseSearchCustomExtractionDictionary schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPEnterpriseSearchCustomExtractionDictionary @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $searchApp = Get-SPEnterpriseSearchServiceApplication Import-SPEnterpriseSearchCustomExtractionDictionary -SearchApplication $searchApp -Filename c:\transfer\entity_extraction.csv -DictionaryName Microsoft.UserDictionaries.EntityExtraction.Custom.Word.1 @@ -44,6 +44,9 @@ The entries of this dictionary will be matched in a case-insensitive way against ## PARAMETERS ### -DictionaryName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the target dictionary. The name must be one of the following 12 predefined dictionaries. The name signifies the "case sensitivity" and "token matching" behavior. @@ -51,8 +54,7 @@ The name signifies the "case sensitivity" and "token matching" behavior. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,15 +65,15 @@ Accept wildcard characters: False ### -FileName -Specifies the file path of the .cvs file to be imported +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the file path of the .cvs file to be imported ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,15 +84,15 @@ Accept wildcard characters: False ### -SearchApplication -Specifies the search service application to which the custom extraction dictionary should be imported. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the search service application to which the custom extraction dictionary should be imported. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +116,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -139,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchPopularQueries.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchPopularQueries.md index 57d0d705e..db9f5b1ac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchPopularQueries.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchPopularQueries.md @@ -7,7 +7,7 @@ title: Import-SPEnterpriseSearchPopularQueries schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPEnterpriseSearchPopularQueries @@ -59,7 +59,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $ssap = Get-SPEnterpriseSearchServiceApplicationProxy $hostname = hostname @@ -76,14 +76,16 @@ The example defines the variable $web as the SPWeb with URL https://hostname, an ## PARAMETERS ### -ResultSource + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Result Source to associate with the imported queries. The type must be an instance of a valid Source object. ```yaml Type: Source Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,14 +95,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy for the search application to which the queries file should be imported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,14 +114,16 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWeb to associate with the imported queries. The type must be an instance of a valid SPWeb object. ```yaml Type: SPWeb Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -127,6 +133,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +147,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +157,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,13 +176,15 @@ Accept wildcard characters: False ``` ### -Filename + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full UNC (Universal Naming Convention) path of the file to import. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -189,7 +204,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchThesaurus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchThesaurus.md index d5641fc1f..1188fd35e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchThesaurus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchThesaurus.md @@ -7,7 +7,7 @@ title: Import-SPEnterpriseSearchThesaurus schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPEnterpriseSearchThesaurus @@ -33,10 +33,10 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` -C:\PS>$searchApp = Get-SPEnterpriseSearchServiceApplication -Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename +C:\PS>$searchApp = Get-SPEnterpriseSearchServiceApplication +Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename \\host\share\thesaurus.csv ``` @@ -45,13 +45,15 @@ This example imports a thesaurus dictionary .csv file named thesaurus.csv that i ## PARAMETERS ### -FileName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full UNC (Universal Naming Convention) path of the .csv file to be imported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +63,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which the thesaurus dictionary should be imported ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchTopology.md index 73f39e010..543b95ba0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPEnterpriseSearchTopology.md @@ -7,7 +7,7 @@ title: Import-SPEnterpriseSearchTopology schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPEnterpriseSearchTopology @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Import-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename .\topology.xml @@ -41,6 +41,9 @@ This example imports a topology from a file named topology.xml to the default se ## PARAMETERS ### -Filename + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and file name of the topology XML file to import. The type must be a valid path, in the form MyFeature\Feature.xml. @@ -48,8 +51,7 @@ The type must be a valid path, in the form MyFeature\Feature.xml. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which to apply the topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPInfoPathAdministrationFiles.md index 58eae94d9..db7cc70a6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPInfoPathAdministrationFiles.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPInfoPathAdministrationFiles.md @@ -7,7 +7,7 @@ title: Import-SPInfoPathAdministrationFiles schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPInfoPathAdministrationFiles @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Import-SPInfoPathAdministrationFiles -path "backupfiles.cab" ``` @@ -40,6 +40,9 @@ This example imports form templates (XSN files) and universal data connections ( ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location of the .cab file to import. The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. @@ -47,8 +50,7 @@ The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the destination InfoPath Forms Services service for the import. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -104,8 +113,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPMetadataWebServicePartitionData.md index 621de622e..990e5c4f1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPMetadataWebServicePartitionData.md @@ -7,7 +7,7 @@ title: Import-SPMetadataWebServicePartitionData schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPMetadataWebServicePartitionData @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE---------------------- +### EXAMPLE ``` $subscription = Get-SPSiteSubscription -Identity https://site_url $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Managed Metadata Service Connection'} @@ -43,6 +43,9 @@ This example restores a backup of Metadata Service application data for a specif ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription to import. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -68,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name of the subscription data file to import. The type must be a valid path in either of the following forms: @@ -89,8 +96,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +120,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,13 +130,15 @@ Accept wildcard characters: False ``` ### -OverwriteExisting + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to overwrite the existing site subscription data, if it exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +148,15 @@ Accept wildcard characters: False ``` ### -NoCompression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +166,15 @@ Accept wildcard characters: False ``` ### -ToContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,13 +184,15 @@ Accept wildcard characters: False ``` ### -ToServiceDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPPerformancePointContent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPPerformancePointContent.md index a7051f636..bb53b13c1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPPerformancePointContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPPerformancePointContent.md @@ -7,7 +7,7 @@ title: Import-SPPerformancePointContent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPPerformancePointContent @@ -28,7 +28,7 @@ The Import-SPPerformancePointContent imports a PPS dashboard and its dependencie ## EXAMPLES -### Example 1 +### Example 1 ``` $ContentList = @{"/bi/Dashboard Content" = "/biprod/Dashboard Content"; "/bi/My Projects" = "/biprod/My Projects"} $DatasourceList = @{"/bi/DataConnections/AdventureWorks.ppsdc" = "/myBi/libraries/DataConnections/AdventureWorks_prod.ppsdc"; "/bi/DataConnections/AW 2008 Cubes4.ppsdc" = "/myBi/libraries/DataConnections/AW 2008 Cubes3.ppsdc"; "/sales/DataConnections/Excel DS.ppsdc" = "/marketing/PPS Data Sources/PDW 2010.ppsdc"} @@ -40,6 +40,9 @@ This example imports a dashboard by using the $Datasourcelist and $ContentList v ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -DatasourceMap + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Maps existing or adds new data sources to destination library. ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -ImportFileUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Path and Name of the CMP file created in the export command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -LocationMap + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Maps the locations between source lists and destination lists. ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -MasterPageUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which master page to use for imported dashboards. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -122,13 +132,15 @@ Accept wildcard characters: False ``` ### -SiteDestination + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site to which the dashboard will be deployed. Also used to determine the location of the import Key Performance Indicator (KPI). ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPScaleOutDatabaseTenantData.md index 5bf5e9cec..1d2c24da2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPScaleOutDatabaseTenantData.md @@ -7,7 +7,7 @@ title: Import-SPScaleOutDatabaseTenantData schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPScaleOutDatabaseTenantData @@ -17,7 +17,6 @@ ms.reviewer: Imports data from the specified subscription id. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ``` Import-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -43,6 +42,9 @@ This example imports data from the file at C:\TenantData.dat, to the specified s ## PARAMETERS ### -FilePath + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the absolute path to the data file. An absolute path includes the root directory and all sub-directories. @@ -50,8 +52,7 @@ An absolute path includes the root directory and all sub-directories. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to import the data to. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,14 +80,16 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription id to import the data from. This value will replace the site subscription id value from the data file. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPServerScaleOutDatabaseTenantData.md index 4a227893e..5f89f61d3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPServerScaleOutDatabaseTenantData.md @@ -7,7 +7,7 @@ title: Import-SPServerScaleOutDatabaseTenantData schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPServerScaleOutDatabaseTenantData @@ -30,30 +30,29 @@ Use the Import-SPServerPScaleOutDatabaseTenantData cmdlet to import data from th ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ``` Import-SPServerScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` This example imports data from the file at C:\TenantData.dat, to the specified service application and marks all the imported data with the site subscription id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904. - ## PARAMETERS ### -FilePath +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the absolute path to the data file. An absolute path includes the root directory and all sub-directories. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,13 +63,14 @@ Accept wildcard characters: False ### -ServiceApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to import the data to. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,14 +81,15 @@ Accept wildcard characters: False ### -SiteSubscriptionId +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription id to import the data from. This value will replace the site subscription id value from the data file. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +100,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +124,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -140,6 +143,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md index 2d5b3c423..10a294e71 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -7,7 +7,7 @@ title: Import-SPSiteSubscriptionBusinessDataCatalogConfig schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPSiteSubscriptionBusinessDataCatalogConfig @@ -17,7 +17,6 @@ ms.reviewer: Imports data associated with an exported file that contains all data associated with the Business Data Connectivity Metadata Store for a given partition. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE--------------------------- +### EXAMPLE ``` Import-SPSiteSubscriptionBusinessDataCatalogConfig -Path "C:\folder\importFile.xml" -ServiceContext http://contoso ``` @@ -43,6 +42,9 @@ This example imports the data file named importFile.xml. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name to use to create the export file.The type must be a valid path in either of the following forms: C:\folder_name @@ -54,8 +56,7 @@ C:\folder_name ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context of the data to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -72,8 +76,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +100,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that names for business data fields in multiple languages be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that Business Data Connectivity models be included in the imported file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that permissions from the Business Data Connectivity model be exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that properties from the Business Data Connectivity model be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -186,13 +201,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that proxies for Business Data Connectivity Service Applications be exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +219,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -209,7 +229,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionSettings.md index 393eb0a8e..230332d22 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPSiteSubscriptionSettings.md @@ -7,7 +7,7 @@ title: Import-SPSiteSubscriptionSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPSiteSubscriptionSettings @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` $subscription = Get-SPSiteSubscription https://site_url Import-SPSiteSubscriptionSettings -Identity $subscription -Path "C:\backups\contoso_settings_file.bak" -Force @@ -42,6 +42,9 @@ This example restores the subscription settings store of contoso.com. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the subscription to restore . The type must be a valid URL, in the form https://site_url, or a GUID, in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. @@ -49,8 +52,7 @@ The type must be a valid URL, in the form https://site_url, or a GUID, in the fo ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location of the input file. The type must be a valid path, in the form C:\filename.bak. @@ -67,8 +72,7 @@ The type must be a valid path, in the form C:\filename.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,14 +82,16 @@ Accept wildcard characters: False ``` ### -AdminProperties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only administrator subscription properties are imported. If this parameter is not set, only non-administrator subscription properties are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +115,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -134,13 +144,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If a setting key already exists, determines whether the value must be overwritten with the value in the backup file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -157,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPWeb.md index 83259aad7..1d2200f29 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Import-SPWeb.md @@ -7,7 +7,7 @@ title: Import-SPWeb schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Import-SPWeb @@ -17,7 +17,6 @@ ms.reviewer: Imports a web, list, or library. - ## SYNTAX ``` @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE---------------------- +### EXAMPLE ``` Import-SPWeb https://site -Path export.cmp -UpdateVersions Overwrite ``` @@ -46,6 +45,9 @@ This example imports the contents of export.cmp into a site at https://site, ove ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the Web to import into. The type must be a valid URL, GUID, or object; for example, a valid URL, in the form https://server_name, or a GUID, in the form, 1234-4567-5678a. @@ -53,8 +55,7 @@ The type must be a valid URL, GUID, or object; for example, a valid URL, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the import file. If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. @@ -71,8 +75,7 @@ If the NoFileCompression parameter is used, a directory must be specified; other ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -ActivateSolutions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether user solutions are activated during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + This parameter has no function in this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -HaltOnError + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Stops the import process when an error occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -HaltOnWarning + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Stops the import process when a warning occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -IncludeUserCustomAction + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether User Custom Actions are included during import. Valid values are: @@ -194,8 +212,7 @@ All, None ```yaml Type: SPIncludeUserCustomAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +223,14 @@ Accept wildcard characters: False ### -IncludeUserSecurity +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Preserves the user security settings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +240,9 @@ Accept wildcard characters: False ``` ### -NoFileCompression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Either enables or disables file compression in the import package. The import package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. @@ -230,8 +251,7 @@ If compression is enabled, the import process can increase by approximately 30 p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -241,6 +261,9 @@ Accept wildcard characters: False ``` ### -NoLogFile + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses the generation of an import log file. If this parameter is absent, the Import-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS). @@ -251,8 +274,7 @@ However, for performance reasons, you might not want to generate a log file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -262,6 +284,9 @@ Accept wildcard characters: False ``` ### -UpdateVersions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates how to resolve situations where a file to be imported to a site already exists in that site. If the UpdateVersions parameter is absent, the import operation by default uses a value of 1 (Append). @@ -282,8 +307,7 @@ Append, Ignore, Overwrite ```yaml Type: SPUpdateVersions Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -293,6 +317,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -300,7 +327,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -310,13 +336,15 @@ Accept wildcard characters: False ``` ### -PreserveDeletedUserMetadataReferences + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Attempts to opulates the 'Author' ('Created By') field for items even if the SPUser object was marked as deleted on the destination site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPResourceSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPResourceSecurity.md index 186f5ca32..da7e49110 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPResourceSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPResourceSecurity.md @@ -7,7 +7,7 @@ title: Initialize-SPResourceSecurity schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Initialize-SPResourceSecurity @@ -17,7 +17,6 @@ ms.reviewer: Enforces resource security on the local server. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Initialize-SPResourceSecurity ``` @@ -42,6 +41,9 @@ This example enforces resource security on the local server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPStateServiceDatabase.md index fd225f0ae..f1c37c4c4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Initialize-SPStateServiceDatabase.md @@ -7,7 +7,7 @@ title: Initialize-SPStateServiceDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Initialize-SPStateServiceDatabase @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` $db = Get-SPStateServiceDatabase -Identity StateServceDbName Initialize-SPStateServiceDatabase -Identity $db @@ -41,6 +41,9 @@ This example installs the state service database schema into the database associ ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to initialize. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -49,7 +52,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-FASTSearchAdminDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-FASTSearchAdminDatabase.md index ff1c87923..b3c82956e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-FASTSearchAdminDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-FASTSearchAdminDatabase.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Install-FASTSearchAdminDatabase --- @@ -37,21 +37,21 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Install-FASTSearchAdminDatabase -DbConnection "Data Source=sqlserver.contoso.com;Database=FASTSearchAdminDatabase;integrated Security=True;" ``` This example installs the database schema in the database server specified by the connection string. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Install-FASTSearchAdminDatabase -Upgrade -DbServer "sqlserver.contoso.com" ``` This example upgrades the database schema already installed in the FAST Search Server 2010 for SharePoint administration database on the given SQL Server instance. -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` Install-FASTSearchAdminDatabase -Force -DbServer "sqlserver.contoso.com" ``` @@ -61,13 +61,15 @@ This example deletes and reinstalls the database schema already installed in the ## PARAMETERS ### -DbConnection + +> Applicable: FAST Server for SharePoint 2010 + Specifies the database connection string for the FAST Search Server 2010 for SharePoint administration database, in the same format as the ConnectionString property of the System.Data.SqlClient.SqlConnection .NET Framework type. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -77,6 +79,9 @@ Accept wildcard characters: False ``` ### -DbName + +> Applicable: FAST Server for SharePoint 2010 + Specifies the name of the FAST Search Server 2010 for SharePoint administration database. The name only takes effect when used in conjunction with the DbServer parameter, not the DbConnection parameter. @@ -84,8 +89,7 @@ The name only takes effect when used in conjunction with the DbServer parameter, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -DbServer + +> Applicable: FAST Server for SharePoint 2010 + Specifies the database server instance that contains the FAST Search Server 2010 for SharePoint administration database. Only one of the DbServer and DbConnection parameters must be specified. @@ -103,8 +110,7 @@ Using DbServer with a value of sqlserver.contoso.com is equivalent to using DbCo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -114,6 +120,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + The Force parameter specifies that the FAST Search Server 2010 for SharePoint administration database already exists, but should be reinstalled. This will delete all data that already exists in the database. @@ -121,8 +130,7 @@ This will delete all data that already exists in the database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -Upgrade + +> Applicable: FAST Server for SharePoint 2010 + Specifies that the FAST Search Server 2010 for SharePoint administration database already exists and that it should be upgraded, because it uses an older version of the database schema. The upgrade process will attempt to migrate all data to the new database schema. @@ -141,8 +152,7 @@ It is strongly recommended that you back up the database before performing this ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApp.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApp.md index 63926a349..8ba648fc6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApp.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApp.md @@ -7,7 +7,7 @@ title: Install-SPApp schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPApp @@ -17,7 +17,6 @@ ms.reviewer: Installs an instance of an app. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------------ +### EXAMPLE ``` $spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://site_url -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) Install-SPApp -Web https://site_url -Identity $spapp @@ -43,14 +42,16 @@ This example installs an app by first importing the app package, and then instal ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app to install. The App object is created by using the Import-SPAppPackage cmdlet. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPWeb object of the app. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApplicationContent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApplicationContent.md index fffbab4b4..59a0c4a43 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApplicationContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPApplicationContent.md @@ -7,7 +7,7 @@ title: Install-SPApplicationContent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPApplicationContent @@ -17,7 +17,6 @@ ms.reviewer: Copies shared application data to existing Web application folders. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE-------------------- +### EXAMPLE ``` Install-SPApplicationContent ``` @@ -43,6 +42,9 @@ This example copies data to a Web application in the existing folders. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +56,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,6 +74,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -During a Cummulative Update installation if you face a situation where the full PSConfig cannot run then this cmdlet should be executed on all SharePoint servers to keep the Farm in a supported state. +During a Cummulative Update installation if you face a situation where the full PSConfig cannot run then this cmdlet should be executed on all SharePoint servers to keep the Farm in a supported state. ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPDataConnectionFile.md index c6c711dd9..a8706cb0b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPDataConnectionFile.md @@ -7,7 +7,7 @@ title: Install-SPDataConnectionFile schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPDataConnectionFile @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Install-SPDataConnectionFile -Path 'C:\folder\sample.udcx' -Category "Install" -WebAccessible $true ``` @@ -45,6 +45,9 @@ This cmdlet is equivalent to the Upload Data Connection File user interface sett ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full path to the name of the file in the data connection store. The type must be the name of a valid data connection file; for example, C:\foldername\myconnection.udcx. @@ -52,8 +55,7 @@ The type must be the name of a valid data connection file; for example, C:\folde ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets an arbitrary category on the file which can be used to group the files. The category name can have a maximum of 255 characters. @@ -93,8 +100,7 @@ The type must be a valid string value; for example, Category1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,14 +129,16 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the existing data connection file. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +148,9 @@ Accept wildcard characters: False ``` ### -WebAccessible + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the universal data connection file can be accessed by using the Web service. If False, only the Forms Server can retrieve the universal data connection files internally. The default value is False. @@ -145,8 +158,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +168,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +178,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPEduSites.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPEduSites.md index 41fb0e22c..e514565ec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPEduSites.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPEduSites.md @@ -7,7 +7,7 @@ title: Install-SPEduSites schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPEduSites @@ -27,23 +27,24 @@ Do not use ## EXAMPLES -### Example 1 +### Example 1 ``` Do not use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -53,13 +54,15 @@ Accept wildcard characters: False ``` ### -MySiteHost + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -SearchCenter + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: 2 @@ -85,13 +90,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPFeature.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPFeature.md index 1139ddfa1..64c4f1ce2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPFeature.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPFeature.md @@ -7,7 +7,7 @@ title: Install-SPFeature schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPFeature @@ -17,7 +17,6 @@ ms.reviewer: Installs a SharePoint Feature by using the Feature.xml file. - ## SYNTAX ### PathSet @@ -54,14 +53,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Install-SPFeature -path "MyCustomFeature" ``` This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Install-SPFeature -AllExistingFeatures -Whatif ``` @@ -69,14 +68,14 @@ Install-SPFeature -AllExistingFeatures -Whatif This example shows the unregistered features that are available on the file system and that are installed if this command is run without the WhatIf parameter. This is commonly done after an upgrade process. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 14 ``` This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature\feature.xml. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 15 ``` @@ -86,6 +85,9 @@ This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an authentic file path; for example, MyFeature. The path to feature must be a literal path to the 14\Template\Features directory. @@ -96,8 +98,7 @@ If the path to the feature is not found , the following error message is display ```yaml Type: String Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -107,13 +108,15 @@ Accept wildcard characters: False ``` ### -AllExistingFeatures + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Scans for existing, but unregistered features, and then registers them with the farm. ```yaml Type: SwitchParameter Parameter Sets: AllExistingFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -123,14 +126,16 @@ Accept wildcard characters: False ``` ### -ScanForFeatures + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Scans and then displays a feature. The ScanForFeatures parameter does not install a feature. ```yaml Type: SwitchParameter Parameter Sets: ScanForFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -140,6 +145,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -151,8 +159,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +169,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of feature to install. When the version is not specified it will default to the web applications MaxVersion value. @@ -170,8 +180,7 @@ The values for this can be either 14 or 15. ```yaml Type: Int32 Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +190,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -188,7 +200,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -198,13 +209,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the installation of an already installed feature. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -214,14 +227,16 @@ Accept wildcard characters: False ``` ### -SolutionId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the solution ID of the features. If the SolutionId parameter is not provided, all solution IDs are scanned. ```yaml Type: String Parameter Sets: AllExistingFeatures, ScanForFeatures -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -238,7 +256,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPHelpCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPHelpCollection.md index 7fa31cc4b..31562d157 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPHelpCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPHelpCollection.md @@ -7,7 +7,7 @@ title: Install-SPHelpCollection schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPHelpCollection @@ -17,7 +17,6 @@ ms.reviewer: Installs the provided Help site collection files in the current farm. - ## SYNTAX ### InstallAll @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Install-SPHelpCollection -LiteralPath 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1033\OSSAdmin.cab' ``` @@ -54,13 +53,15 @@ This example installs the specified help collection in the current farm. ## PARAMETERS ### -All + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If the LiteralPath parameter is not specified, specifies that all Help Collection CABs under %Program Files%\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\\\ in the Help site collection are installed, and existing Help collections are overwritten. ```yaml Type: SwitchParameter Parameter Sets: InstallAll -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -LiteralPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the exact path to a specific custom Help file in the Help site collection cab file. The type must be a valid path in either of the following forms: @@ -80,8 +84,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: InstallOne -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +108,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPInfoPathFormTemplate.md index 7bc1e80cb..91c55b390 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPInfoPathFormTemplate.md @@ -7,7 +7,7 @@ title: Install-SPInfoPathFormTemplate schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPInfoPathFormTemplate @@ -29,15 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES - -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Install-SPInfoPathFormTemplate -Path c:\Form.xsn ``` This example installs a single form template to the farm. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` "FormTemplateFirst.xsn", "FormTemplateSecond.xsn", "FormTemplateThird.xsn" | Install-SPInfoPathFormTemplate ``` @@ -47,6 +46,9 @@ This example installs multiple form templates on a farm. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name of the form template to install. The type must be a valid path and file name of a form template, in the form: @@ -57,8 +59,7 @@ The type must be a valid path and file name of a form template, in the form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +83,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -97,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -EnableGradualUpgrade + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new form can be gradually upgraded. - If specified and the form template file exists, the form template is gradually upgraded and is then used for new sessions only. @@ -117,8 +125,7 @@ Specifies that the new form can be gradually upgraded. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -NoWait + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the form template is installed in the background and that the progress of the installation not be shown. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +163,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPService.md index bf17b8928..be2fed00a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPService.md @@ -7,7 +7,7 @@ title: Install-SPService schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPService @@ -17,7 +17,6 @@ ms.reviewer: Installs and provisions services on a farm. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Install-SPService ``` @@ -43,6 +42,9 @@ This example installs all services, service instances and service proxies specif ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +56,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,13 +66,15 @@ Accept wildcard characters: False ``` ### -Provision + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies default settings when installing a standalone service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPSolution.md index 3f0d6bf9a..7b80a7914 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPSolution.md @@ -7,7 +7,7 @@ title: Install-SPSolution schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPSolution @@ -17,7 +17,6 @@ ms.reviewer: Deploys an installed SharePoint solution in the farm. - ## SYNTAX ### Deploy @@ -46,17 +45,16 @@ Use the Add-SPSolution cmdlet to install a SharePoint solution package in the fa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Install-SPSolution -Identity contoso_solution.wsp -GACDeployment ``` This example deploys the installed SharePoint solution contoso_solution.wsp in the farm and specifies that GAC can be deployed for the new SharePoint solution. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Install-SPSolution -Identity contoso_solution.wsp -GACDeployment -CompatibilityLevel {14,15} ``` @@ -66,15 +64,17 @@ This example deploys the installed SharePoint solution installs a previously add ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint solution to deploy. The value must be an authentic GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an authentic name of a SharePoint solution (for example, SPSolution1); or an instance of an authentic SPSolution object. ```yaml Type: SPSolutionPipeBind -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: Deploy, Synchronize +Aliases: Required: True Position: 1 @@ -83,27 +83,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSolutionPipeBind -Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -AllWebApplications -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -AllWebApplications Specifies that the new SharePoint solution is deployed for all SharePoint web applications in the farm. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +116,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +126,15 @@ Accept wildcard characters: False ``` ### -CASPolicies + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that code access security (CAS) policies can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +145,8 @@ Accept wildcard characters: False ### -CompatibilityLevel +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to install into the solution, into a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to install the solution only to the version directory based on the version tracked in the manifest of the solution's cab file. Valid values are: @@ -165,8 +160,7 @@ Valid values are: ```yaml Type: String Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +170,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +180,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -193,13 +189,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the deployment of the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +207,9 @@ Accept wildcard characters: False ``` ### -FullTrustBinDeployment + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that full trust Bin deployment is permitted. This parameter is to be used if the solution is fully trusted. @@ -219,8 +220,7 @@ For additional information about bin assembly, see Assembly Element ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +230,15 @@ Accept wildcard characters: False ``` ### -GACDeployment + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that global assembly cache (GAC) can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +248,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a language for the solution when a solution language package is deployed. If this parameter is not specified, zero ("0") is assumed. Use zero for solutions that are valid for all languages. @@ -253,8 +258,7 @@ Use zero for solutions that are valid for all languages. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -264,13 +268,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deploys the solution on the active server. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -280,13 +286,15 @@ Accept wildcard characters: False ``` ### -Synchronize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Synchronizes all solutions or the specified solution in the local farm. ```yaml Type: SwitchParameter Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -296,6 +304,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies when the solution will be deployed. The default value is immediate deployment. @@ -304,8 +315,7 @@ The type must be a valid DateTime value, in the form 2010, 5, 1. ```yaml Type: String Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -316,6 +326,8 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deploys the SharePoint solution for the specified SharePoint web application. The value must be in one of the following forms: @@ -329,8 +341,7 @@ The value must be in one of the following forms: ```yaml Type: SPWebApplicationPipeBind Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -340,6 +351,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -347,7 +361,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPUserSolution.md index 3e7e260b2..f13d34e58 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPUserSolution.md @@ -7,7 +7,7 @@ title: Install-SPUserSolution schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPUserSolution @@ -17,7 +17,6 @@ ms.reviewer: Activates a sandboxed solution in a site collection. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ``` Install-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` @@ -43,6 +42,9 @@ This example activates the sandboxed solution contoso_solution.wsp in the site h ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution to activate. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -50,8 +52,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Activates the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -68,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPWebPartPack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPWebPartPack.md index 41de9ac63..fa5eac3d1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPWebPartPack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Install-SPWebPartPack.md @@ -7,7 +7,7 @@ title: Install-SPWebPartPack schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Install-SPWebPartPack @@ -52,7 +52,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Install-SPWebPartPack "MyCustomWebPartPack" -LiteralPath "C:\mywebpart.wpp" -GlobalInstall ``` @@ -62,13 +62,15 @@ This example installs the Web Part Package with the name MyCustomWebPartPack glo ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the exact path to the Web Part package. ```yaml Type: String Parameter Sets: UseFileName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -78,13 +80,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Web Part package to install. ```yaml Type: String Parameter Sets: UseName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -94,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +112,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -133,13 +141,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites any existing Web Part package with the same name or installed in the same location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +159,16 @@ Accept wildcard characters: False ``` ### -GlobalInstall + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Installs the Web Part package in the global assembly cache (GAC) rather than in the /bin directory of each Web application. This installation makes the Web Part globally accessible on the servers. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +178,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language ID for the Web Part package. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,14 +196,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application on which to install the Web Part pack. If no Web application is specified, the Web Part pack is installed on all Web applications. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -206,7 +225,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -216,13 +234,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index caa717ace..9d47a5bf8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -7,7 +7,7 @@ title: Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync @@ -46,7 +46,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync https://localhost/pwa ``` @@ -56,13 +56,15 @@ This example triggers an Active Directory Enterprise Resource Pool synchronizati ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance where you want to invoke a synchronization. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryGroupSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryGroupSync.md index 557c2347c..5514a1408 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryGroupSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Invoke-SPProjectActiveDirectoryGroupSync.md @@ -7,7 +7,7 @@ title: Invoke-SPProjectActiveDirectoryGroupSync schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Invoke-SPProjectActiveDirectoryGroupSync @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ``` Invoke-SPProjectActiveDirectoryGroupSync -Url https://AppServer/pwa ``` @@ -40,6 +40,9 @@ This example synchronizes group membership for the specified PWA instance. ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App (PWA) instance where you want to start the Active Directory sync. The type must be a valid URL, in the form https://\/\. @@ -47,8 +50,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPLogFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPLogFile.md index fd3e291a9..1f9335640 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPLogFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPLogFile.md @@ -7,7 +7,7 @@ title: Merge-SPLogFile schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Merge-SPLogFile @@ -17,7 +17,6 @@ ms.reviewer: Combines trace log entries from all farm computers into a single log file on the local computer. - ## SYNTAX ``` @@ -38,56 +37,56 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite ``` This example merges the last hour of log data from all farm computers with no filtering. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area Search ``` This example merges the last hour of log data from the Search area. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area "SharePoint Foundation","Web Analytics Services" ``` This example merges the last hour of log data from the SharePoint Foundation and Web Analytics Services areas. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Level High ``` This example merges the log data of level High or higher. -### --------------EXAMPLE 5----------------- +### EXAMPLE 5 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -StartTime "06/09/2008 16:00" -EndTime "06/09/2008 16:15" ``` This example merges the log data for events in a particular time range, which is culture-specific to the United States. -### --------------EXAMPLE 6----------------- +### EXAMPLE 6 ``` Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Message "*permission changed*" ``` This example merges the log data for events with permission changed in the message text. -### --------------EXAMPLE 7----------------- +### EXAMPLE 7 ``` Merge-SPLogFile -Overwrite -Path d:\1.log -ContextFilter "name=timer job*" -Area "*search*" ``` This example merges the log data for all search timer jobs. -### --------------EXAMPLE 8----------------- +### EXAMPLE 8 ``` Merge-SPLogFile -Overwrite -Path d:\2.log -ContextFilter "user=contoso?joeuser" ``` @@ -97,14 +96,16 @@ This example shows how to merge the log data for all user names that have a cont ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and file name to which to write the merged log file. Relative paths are supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -114,6 +115,9 @@ Accept wildcard characters: False ``` ### -Area + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the area name to filter on. The type must be a valid name; for example, SharePoint Foundation. @@ -123,8 +127,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -145,8 +151,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +161,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category ID to filter on. The type must be a valid category name; for example, category1. @@ -165,8 +173,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,13 +183,15 @@ Accept wildcard characters: False ``` ### -ContextFilter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a filter for trace entries in a particular context in the form key=value, for example, user=contoso\joeuser. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -192,14 +201,16 @@ Accept wildcard characters: False ``` ### -Correlation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the correlation ID to filter on. The type must be a valid GUID, in the form F0BB0790-4323-A153-096F-ABCDC80E24D4. ```yaml Type: Guid[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +220,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the end time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. @@ -216,8 +230,7 @@ The type must be a valid DateTime format that is culture-specific to the adminis ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,14 +240,16 @@ Accept wildcard characters: False ``` ### -EventID + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Event ID to filter on. The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +259,9 @@ Accept wildcard characters: False ``` ### -ExcludeNestedCorrelation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Excludes nested correlation values in the results. This parameter is only used when filtering results by using the ContextFilter parameter @@ -253,8 +271,7 @@ Specifying this option includes only the records that match the filter and exclu ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +281,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the level name to filter on. Results include the specified level and everything more severe. @@ -271,8 +291,7 @@ Results include the specified level and everything more severe. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -282,6 +301,9 @@ Accept wildcard characters: False ``` ### -Message + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the message text to filter on. The type must be valid text. @@ -292,8 +314,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -303,6 +324,9 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Overwrites the log file if it already exists at the specified path. The type must be either of the following values: @@ -315,8 +339,7 @@ The default value is $False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -326,6 +349,9 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the process name to filter on. The use of wildcards is supported. @@ -333,8 +359,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -344,6 +369,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the start time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. @@ -353,8 +381,7 @@ The default is one hour prior to the current time on the local computer. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -364,6 +391,9 @@ Accept wildcard characters: False ``` ### -ThreadID + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the thread ID to filter on. The type must be a valid integer from 0 through 4,294,967,295. @@ -371,8 +401,7 @@ The type must be a valid integer from 0 through 4,294,967,295. ```yaml Type: UInt32[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPUsageLog.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPUsageLog.md index b404549f0..27d413a12 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPUsageLog.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Merge-SPUsageLog.md @@ -7,7 +7,7 @@ title: Merge-SPUsageLog schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Merge-SPUsageLog @@ -34,7 +34,7 @@ This cmdlet requires PowerShell Remoting to be enabled. ## EXAMPLES -### Example 1 +### Example 1 ``` Merge-SPUsageLog -Identity 'Timer Jobs' -Servers SPSERVER1 ``` @@ -44,6 +44,9 @@ Merges the Usage log for the Usage Definition 'Timer Jobs' from the specified se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -DiagnosticLogPath + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the file to write diagnostic information to. A relative path is supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the end time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, that is, 2/16/2007 12:15:12 for English-US. @@ -89,8 +96,7 @@ If you want to specify UTC time, you must add a "Z" to the end of the parameter. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +106,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of usage log file. ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -116,13 +124,15 @@ Accept wildcard characters: False ``` ### -OverWrite + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Overwrites the diagnostic log file if it already exists at the specified path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -Partial + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Not used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -Servers + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The server address or addresses to filter on. To obtain a list of valid addresses in the farm use Get-SPServer | Select Address. @@ -155,8 +170,7 @@ To obtain a list of valid addresses in the farm use Get-SPServer | Select Addres ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +180,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the start time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as "2/16/2007 12:15:12" for English-US. @@ -177,8 +194,7 @@ If you want to specify UTC time, you must add a "Z" to the end of the parameter. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPDatabase.md index acb0f9148..ab05cb174 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPDatabase.md @@ -7,7 +7,7 @@ title: Migrate-SPDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Migrate-SPDatabase @@ -37,7 +37,7 @@ Do not use. ## EXAMPLES -### Example 1 +### Example 1 ``` #Do not use. ``` @@ -47,6 +47,9 @@ Do not use. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -54,8 +57,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016 Required: False Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 1 @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 0 @@ -113,13 +121,15 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: 4 @@ -129,14 +139,16 @@ Accept wildcard characters: False ``` ### -ServiceType + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: ServiceExtensionType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: DefaultDatabase, Project, UserProfile, SiteSubscription, BDC, Securityobjects, Taxonomy, AppManagement, All -Applicable: SharePoint Server 2016 Required: True Position: 3 @@ -146,13 +158,15 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 2 @@ -162,13 +176,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 2 @@ -178,13 +194,15 @@ Accept wildcard characters: False ``` ### -UseLinkedSqlServer + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: 5 @@ -194,6 +212,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -201,7 +222,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectDatabase.md index a14f1100c..120f11d0c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectDatabase.md @@ -7,7 +7,7 @@ title: Migrate-SPProjectDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Migrate-SPProjectDatabase @@ -30,7 +30,7 @@ Both the Project Server 2013 database and the SharePoint Server 2016 database mu Server and the SharePoint farm account must have full access to the Project Server 2013 database. During the migration process the Project Server 2013 database will be modified and cannot be mounted back to a Project Server 2013. ## EXAMPLES -### Example 1 +### Example 1 ``` Migrate-SPProjectDatabase -DatabaseName ProjectDB1 -SiteCollection "https://contoso1/sites/PWA" ``` @@ -40,6 +40,9 @@ This example will look for a Project Server 2013 database named ProjectDB1 on th ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +50,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Project Server 2016 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Project Server 2016 Required: False Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: Project Server 2016 + The name of the Project Server 2013 database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: True Position: Named @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: Project Server 2016 + The name of the instance of SQL Server hosting the Project Server 2013 database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: False Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -FailoverPartner + +> Applicable: Project Server 2016 + The name of the SQL Server failover partner for the Project Server 2013 database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: False Position: Named @@ -122,13 +132,15 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: Project Server 2016 + Specifies to overwrite any Project data from previous attempts. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: False Position: Named @@ -138,13 +150,15 @@ Accept wildcard characters: False ``` ### -SQLLogon + +> Applicable: Project Server 2016 + SQL Server authentication credentials if needed. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: False Position: Named @@ -154,13 +168,15 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: Project Server 2016 + The URL of the site collection to which you want to copy the Project data. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016 +Aliases: Required: True Position: Named @@ -170,6 +186,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Project Server 2016 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -177,7 +196,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Project Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectResourcePlans.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectResourcePlans.md index a85e12431..1f1872c68 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectResourcePlans.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Migrate-SPProjectResourcePlans.md @@ -7,7 +7,7 @@ title: Migrate-SPProjectResourcePlans schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Migrate-SPProjectResourcePlans @@ -27,7 +27,7 @@ Migrates the published resource plan assignment data to engagements. Run after d ## EXAMPLES -### Example 1 +### Example 1 ``` Migrate-SPProjectResourcePlans -Url https://pwa_site ``` @@ -36,6 +36,9 @@ Migrates the Project Resource Plans on the Project Web App site https://pwa_site ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2016, Project Server 2019 + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPContentDatabase.md index 14298ad30..96e0c6d51 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPContentDatabase.md @@ -7,7 +7,7 @@ title: Mount-SPContentDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Mount-SPContentDatabase @@ -18,7 +18,6 @@ Attaches an existing content database to the farm. NOTE: Please be aware that if a content database that does not exists is specified, it will be created by this cmdlet. - ## SYNTAX ``` @@ -43,7 +42,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename ``` @@ -52,7 +51,7 @@ This example mounts an existing database to the sitename web application. If upgrades are required, it triggers database schema upgrade and then performs only build-to-build upgrade actions on existing site collections if required. This operation does not changed the CompatibilityLevel for existing site collections in this database. -### -----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename -NoB2BSiteUpgrade ``` @@ -64,6 +63,9 @@ This operation does not change the CompatibilityLevel for existing site collecti ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing content database to attach to the farm. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -71,8 +73,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Attaches the content database to the specified SharePoint web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -89,8 +93,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -AssignNewDatabaseId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Creates a new database ID automatically when the content database is attached. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -ChangeSyncKnowledge + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Database attach will cause all Groove sync client to re-synchronize their content. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -161,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -171,13 +182,15 @@ Accept wildcard characters: False ``` ### -ClearChangeLog + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Clears any pending changes from the change log in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Authentication. The type must be a valid PSCredential object. @@ -194,8 +210,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +220,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the content database specified in the Name parameter. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -212,8 +230,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +240,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of web sites that can use the content database. The type must be a positive integer. @@ -230,8 +250,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -241,13 +260,15 @@ Accept wildcard characters: False ``` ### -UpdateUserExperience + +> Applicable: SharePoint Server 2010 + Determines whether the content databases should upgrade to the latest user interface. By default, the user interface will not change during upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010 +Aliases: Required: False Position: Named @@ -256,16 +277,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -NoB2BSiteUpgrade + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies not to upgrade all child objects when performing a build-to-build upgrade. This parameter has no effect when a version-to-version upgrade is specified. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -275,13 +297,15 @@ Accept wildcard characters: False ``` ### -SkipIntegrityChecks + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the upgrade process not to run the internal integrity checks such as missing templates, and orphan detection as part of the upgrade process. - + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -291,6 +315,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -298,8 +325,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -309,6 +335,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -316,7 +345,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -326,13 +354,15 @@ Accept wildcard characters: False ``` ### -DatabaseAccessCredentials + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the credential that belong to SPDataAccess role. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,13 +372,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server to be mirrored. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -358,13 +390,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to not upgrade all site objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -374,6 +408,9 @@ Accept wildcard characters: False ``` ### -UseLatestSchema + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to use the latest schema. In an on-premises environment, this parameter has no effect. There are two values $True and $False. @@ -383,8 +420,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPSiteMapDatabase.md index 394b699a8..2a671259e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPSiteMapDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPSiteMapDatabase.md @@ -7,7 +7,7 @@ title: Mount-SPSiteMapDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Mount-SPSiteMapDatabase @@ -28,7 +28,7 @@ Do not use. ## EXAMPLES -### Example 1 +### Example 1 ``` #Do not use. ``` @@ -38,6 +38,9 @@ Do not use. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016 Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -104,13 +112,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: 0 @@ -120,13 +130,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2016 + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -136,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -143,7 +158,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPStateServiceDatabase.md index 6eecce763..90387968e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Mount-SPStateServiceDatabase.md @@ -7,7 +7,7 @@ title: Mount-SPStateServiceDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Mount-SPStateServiceDatabase @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" ``` @@ -42,7 +42,7 @@ This example is used in least privilege scenarios when an administrator cannot c The database must already exist and be empty. The database cannot be used until the Initialize-SPStateServiceDatabase cmdlet is run, so errors could occur with this example. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" -ServiceApplication "ServiceApp1" -Weight 10 | Initialize-SPStateServiceDatabase ``` @@ -53,13 +53,15 @@ The result is immediately piped to the Initialize-SPStateServiceDatabase cmdlet ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database name that is created in the SQL Server database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -99,8 +106,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +116,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -117,8 +126,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +136,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to which to add the state database. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -135,8 +146,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +156,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the weight for the state database used to load balance the allocation of new data. The default value is 1. @@ -154,8 +167,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPAppManagementData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPAppManagementData.md index 4a6dd24f7..a2a2d2974 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPAppManagementData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPAppManagementData.md @@ -7,7 +7,7 @@ title: Move-SPAppManagementData schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPAppManagementData @@ -28,15 +28,17 @@ Do Not Use ## EXAMPLES -### Example 1 +### Example 1 ``` Do Not Use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -OverWrite + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,12 +92,14 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,12 +109,14 @@ Accept wildcard characters: False ``` ### -SourceAppManagementDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -117,13 +126,15 @@ Accept wildcard characters: False ``` ### -TargetContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -133,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -140,7 +154,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPBlobStorageLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPBlobStorageLocation.md index 15a3f62cc..82d6a67e9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPBlobStorageLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPBlobStorageLocation.md @@ -7,7 +7,7 @@ title: Move-SPBlobStorageLocation schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPBlobStorageLocation @@ -17,7 +17,6 @@ ms.reviewer: Copies a content database to a new location by using Remote BLOB Storage (RBS). - ## SYNTAX ``` @@ -37,14 +36,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Move-SPBlobStorageLocation WSS_Content ``` This example copies the content database named WSS_Content from the Windows Internal Database to the same database name in SQL Server 2008 Express by using RBS. -### -------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Move-SPBlobStorageLocation WSS_Content -DestinationDatabase WSS_V4_Content -BackupDatabase WSSBackupDB -VerboseMod:$true ``` @@ -57,13 +56,15 @@ The output of this command displays log information to the Command Prompt window ## PARAMETERS ### -SourceDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Windows Internal Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -112,14 +117,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the migrated database. If the DestinationDatabase parameter is not specified, the SourceDatabase parameter is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -DestinationDataSourceInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the instance of the destination database. The value in the SourceDatabase parameter is migrated to this instance. The name of the instance of the database should be SQL Server with Service Pack 1 (SP1) and Cumulative Update 2 version or higher. @@ -137,8 +147,7 @@ If the DestinationDataSourceInstance parameter is not specified, the local host ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -Dir + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Used for all disk operations, including storing temporary backups and database (.mdf) files of a migrated database. If the Dir parameter is not specified, a default directory of the destination SQL Server instance is used. The free space in this directory should be at least two times the size of the source database. @@ -155,8 +167,7 @@ The free space in this directory should be at least two times the size of the so ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +177,16 @@ Accept wildcard characters: False ``` ### -VerboseMod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Generates verbose log output to be displayed in the Command Prompt window. If the VerboseMod parameter is not specified, no output is displayed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -190,7 +206,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPDeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPDeletedSite.md index b90a213c8..651b64a35 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPDeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPDeletedSite.md @@ -7,7 +7,7 @@ title: Move-SPDeletedSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPDeletedSite @@ -17,7 +17,6 @@ ms.reviewer: Moves deleted site collections from one content database to another. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE---------- +### EXAMPLE ``` Move-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c -DestinationDatabase "ContentDB2" ``` @@ -43,14 +42,16 @@ This example moves deleted site collections from the specified GUID to the datab ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the site collection to be moved. For example, https://servername/sites/sitename. ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,14 +61,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database that the site collection should be moved to. For example, ContentDB2. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,14 +123,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -RbsProviderMapping + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Used to move a Remote BLOB Storage (RBS)-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying Binary Large Object (BLOB) content. If the content database has more than one RBS provider associated with it, you must specify all providers. The same providers must be enabled on the target content database and the source content database. @@ -140,8 +152,7 @@ The same providers must be enabled on the target content database and the source ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -158,8 +172,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +192,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPEnterpriseSearchLinksDatabases.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPEnterpriseSearchLinksDatabases.md index 8d341fdf5..68c6f02da 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPEnterpriseSearchLinksDatabases.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPEnterpriseSearchLinksDatabases.md @@ -7,7 +7,7 @@ title: Move-SPEnterpriseSearchLinksDatabases schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPEnterpriseSearchLinksDatabases @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceapplication $ssa | New-SPEnterpriseSearchLinksDatabase -DatabaseName "links1" @@ -51,6 +51,8 @@ This example adds 3 new links databases and uses Move-SPEnterpriseSearchLinksDat ### -SearchApplication +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -58,12 +60,10 @@ Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -74,6 +74,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,12 +85,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,16 +99,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,15 +119,15 @@ Accept wildcard characters: False ### -RepartitioningId -Resumes the move with this identifier. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Resumes the move with this identifier. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,16 +138,16 @@ Accept wildcard characters: False ### -SourceStores +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a source list of databases. If this parameter is not specified then all currently existing links databases will be used as a source list. - ```yaml Type: LinksStore[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,16 +158,16 @@ Accept wildcard characters: False ### -TargetStores +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a target list of databases. If this parameter is not specified then all currently existing links databases will be used as a target list. - ```yaml Type: LinksStore[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,16 +178,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPProfileManagedMetadataProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPProfileManagedMetadataProperty.md index 0e8f8dd49..4f978cfd3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPProfileManagedMetadataProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPProfileManagedMetadataProperty.md @@ -7,7 +7,7 @@ title: Move-SPProfileManagedMetadataProperty schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPProfileManagedMetadataProperty @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------------ +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Move-SPProfileManagedMetadataProperty -ProfileServiceApplicationProxy $proxy -Identity SPS-Interests -TermSetName Interests -AvailableForTagging @@ -46,13 +46,15 @@ This example moves values from the SPS-Interests property into a new term set ca ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the profile property that needs to be migrated to the taxonomy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +106,9 @@ Accept wildcard characters: False ``` ### -AvailableForTagging + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether the terms in the resulting term set can be used for Managed Metadata tagging. If a term set has more than 30,000 terms, using it for Managed Metadata tagging may lead to performance issues on the client computer. Because a majority of the profile properties may have more than 30,000 terms, the default value is No. @@ -107,8 +116,7 @@ Because a majority of the profile properties may have more than 30,000 terms, th ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -135,14 +145,16 @@ Accept wildcard characters: False ``` ### -TermSetName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When specified, the term set name is created. If the TermSetName parameter is not specified, the property is mapped to the Keywords term set in Managed Metadata Service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSite.md index b9054e3ba..059a52ff7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSite.md @@ -7,7 +7,7 @@ title: Move-SPSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPSite @@ -17,7 +17,6 @@ ms.reviewer: Moves site collections from one content database to another. - ## SYNTAX ``` @@ -32,7 +31,7 @@ The Move-SPSite cmdlet moves the data in the specified site collection from its A no-access lock is applied to the site collection to prevent users from altering data within the site collection while the move is taking place. -Once the move is complete, the site collection is returned to its original lock state. +Once the move is complete, the site collection is returned to its original lock state. An IIS reset is required on any server running the Microsoft SharePoint Foundation Web Application service for the site move to take effect. This is not required for SharePoint Server 2019. @@ -41,24 +40,23 @@ The destination content database specified must already exist, must be attached For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Move-SPSite https://servername/sites/sitename -DestinationDatabase ContentDb2 ``` This example moves the site collection https://servername/sites/sitename to the content database ContentDb2. -### ---------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPSite -ContentDatabase ContentDb1 | Move-SPSite -DestinationDatabase ContentDb2 ``` This example moves all site collections in ContentDb1 to ContentDb2. -### ---------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` Get-SPSiteAdministration | where { $_.OwnerLoginName -eq "DOMAIN\username" } | Move-SPSite -DestinationDatabase ContentDb2 ``` @@ -67,7 +65,7 @@ This example moves all site collections where DOMAIN\username is the site collec The Get-SPSiteAdministration cmdlet is used instead of the Get-SPSite cmdlet because you must have permission within the site collection to access the properties of the SPSite object. You can access the properties of the SPSiteAdministration object as a SharePoint farm administrator. -### ---------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ``` Move-SPSite -Identity siteUrl -DestinationDatabase databaseName -RbsProviderMapping @{"sourceProvider1"="targetProvider1", "sourceProvider2"="targetProvider2"} @@ -78,14 +76,16 @@ This example moves an RBS-enabled site collection from one RBS-enabled content d ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the site collection to be moved. For example, https://servername/sites/sitename. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -95,14 +95,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database that the site collection should be moved to. For example, ContentDB2. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -112,6 +114,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +128,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,6 +157,9 @@ Accept wildcard characters: False ``` ### -RbsProviderMapping + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + This parameter was added in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). Used to move an RBS-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying BLOB content. @@ -160,8 +169,7 @@ The same providers must be enabled on the target content database and the source ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +179,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -188,6 +198,9 @@ Accept wildcard characters: False ``` ### -CopyEvents + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if events of the EventCache table need to be copied to the destination Content Database. The valid values are True or False. @@ -195,8 +208,7 @@ The valid values are True or False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSocialComment.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSocialComment.md index 9ec61c789..b2c3d9a0d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSocialComment.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPSocialComment.md @@ -7,7 +7,7 @@ title: Move-SPSocialComment schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPSocialComment @@ -34,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### Example 1 +### Example 1 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Move-SPSocialComments -ProfileServiceApplicationProxy $proxy -OldUrl "https://contoso/Pages/oldtest.aspx" -NewUrl "https://contoso/Pages/newtest.aspx" @@ -45,6 +45,9 @@ This example moves social comments from oldtest.aspx to newtest.aspx. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -52,8 +55,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -NewUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the target URI to which the social notes will be moved. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,13 +101,15 @@ Accept wildcard characters: False ``` ### -OldUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the source URI from which the social notes will be moved. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,13 +119,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -127,6 +137,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. @@ -134,8 +147,7 @@ This parameter is mandatory in a hosted-environment and optional in a non-hosted ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -152,7 +167,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPUser.md index a5a3335e8..1d877c537 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Move-SPUser.md @@ -7,7 +7,7 @@ title: Move-SPUser schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Move-SPUser @@ -17,7 +17,6 @@ ms.reviewer: Migrates a user account in SharePoint Products. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $user = Get-SPUser -Identity "DOMAIN\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "Domain\JaneSmith" -IgnoreSid @@ -41,7 +40,7 @@ Move-SPUser -Identity $user -NewAlias "Domain\JaneSmith" -IgnoreSid This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $user = Get-SPUser -Identity "DomainA\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "DomainB\JaneDoe" @@ -49,7 +48,7 @@ Move-SPUser -Identity $user -NewAlias "DomainB\JaneDoe" This example migrates DOMAIN\JaneDoe from DomainA to the new account of DOMAINB\JaneDoe in DomainB with SID History enabled. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` $user = Get-SPUser -Identity "i:0#.w|DOMAIN\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "i:0#.w|Domain\JaneSmith" -IgnoreSid @@ -60,6 +59,9 @@ This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith when ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the `SPUser` object retrieved via `Get-SPUser`. The type must be a valid `SPUser` object. @@ -68,7 +70,6 @@ The type must be a valid `SPUser` object. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -NewAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new login name of the user account. The type must be a valid login name, in the form DOMAIN\username. @@ -85,8 +89,7 @@ The type must be a valid login name, in the form DOMAIN\username. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -IgnoreSID + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates (if present) that Active Directory will not be queried for the SID history attribute to ensure that the new login name is correspondent to the old login name. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchContentCollection.md index 771f8f94a..14845e8e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchContentCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchContentCollection.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchContentCollection --- @@ -29,21 +29,21 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchContentCollection -Name newscollection ``` This example creates a new FAST Search Server 2010 for SharePoint content collection named "newscollection". -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` New-FASTSearchContentCollection -Name newscollection -Description "A collection for news content" ``` This example creates a new content collection named "newscollection", and attaches a description to it. -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` New-FASTSearchContentCollection -Name newscollection -Description "A collection for news content" -Pipeline "Office14 (webcluster)" ``` @@ -53,13 +53,15 @@ This example creates a new content collection, and uses the FAST Search Server 2 ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the FAST Search Server 2010 for SharePoint content collection to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -69,13 +71,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A description of the content collection to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -Pipeline + +> Applicable: FAST Server for SharePoint 2010 + The FAST Search Server 2010 for SharePoint document processing pipeline used to feed content to the content collection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCategory.md index ab788bee6..4643014e6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCategory.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataCategory --- @@ -31,7 +31,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$guid = [guid]::NewGuid() New-FASTSearchMetadataCategory -Name ExampleCategory -Propset $guid @@ -45,13 +45,15 @@ See Set-FASTSearchMetadataCategory for descriptions of category properties. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the new category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -Propset + +> Applicable: FAST Server for SharePoint 2010 + The property set Global Unique Identifier (GUID) assigned to this category. A GUID is a 128-bit integer that has a very low probability of being duplicated. The GUID can be specified either in the form of a System.Guid object, or as a 128-bit integer with the format "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". @@ -69,8 +74,7 @@ A crawled property can only be mapped to one category at a time. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledProperty.md index a08e00be6..5c5ffbede 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledProperty.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataCrawledProperty --- @@ -32,7 +32,7 @@ A crawled property is uniquely defined by three properties: -- The property set to which the crawled property is mapped, specified as a GUID (Global Unique Identifier). The GUID identifies which category the crawled property belongs to. A crawled property must be a member of a category. -- The variant type of the crawled property, which specifies the crawled property's data type. -To include content in the full text indexes, crawled properties must be mapped to managed properties. +To include content in the full text indexes, crawled properties must be mapped to managed properties. If a crawled property has IsMappedToContents set to "true", then the crawled property will automatically be added to the default searchable index (the full text index called "content"). A newly created crawled property has its IsMappedToContents parameter set to the same value as the mapped-to category's MapToContents parameter. @@ -44,7 +44,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$guid = [guid]::NewGuid() New-FASTSearchMetadataCategory -Name MoreWeb -Propset $guid @@ -56,7 +56,7 @@ The data type of the crawled property is a Unicode string (VT_LPWSTR, variant ty The new category gets the property set value "e20d8de2-0b5c-46f8-993d-6cdacbda5164", which was randomly generated by the System.GUID.NewGuid() method. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchMetadataCrawledProperty | Where-Object -filterscript { $_.CategoryName -eq "Web"} New-FASTSearchMetadataCrawledProperty -Name Internaltitle -varianttype 31 -Propset d1b5d3f0-c0b3-11cf-9a92-00a0c908dbf1 @@ -79,13 +79,15 @@ To use this crawled property, you must configure the connector or feeding applic ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the new crawled property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -95,6 +97,9 @@ Accept wildcard characters: False ``` ### -Propset + +> Applicable: FAST Server for SharePoint 2010 + The property set GUID of the new crawled property. The GUID controls which category the crawled property belongs to. @@ -104,8 +109,7 @@ The GUID can be specified either as a System.Guid object, or as an integer havin ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -115,14 +119,16 @@ Accept wildcard characters: False ``` ### -VariantType + +> Applicable: FAST Server for SharePoint 2010 + An integer value specifying the data type of the crawled property. See https://go.microsoft.com/fwlink/?LinkId=163232 (https://go.microsoft.com/fwlink/?LinkId=163232) for a list of common variant types. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledPropertyMapping.md index c167013d4..5e5bee186 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledPropertyMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataCrawledPropertyMapping.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataCrawledPropertyMapping --- @@ -36,7 +36,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$sitetitle_managedproperty = Get-FASTSearchMetadataManagedProperty -Name sitetitle $internaltitle_crawledproperty = Get-FASTSearchMetadataCrawledProperty -name internaltitle @@ -49,7 +49,7 @@ Note that both the crawled property and the managed property already exist, and As a result, the crawled property "internaltitle" will now be mapped to "sitetitle" and stored in the FAST Search Server 2010 for SharePoint system. The managed property can then be included in a full text index to make it searchable. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$extended_title = New-FASTSearchMetadataManagedproperty -name ExtendedTitle -Type 1 $title = Get-FASTSearchMetadataManagedProperty -name title @@ -66,13 +66,15 @@ More crawled properties can be added to this new managed property later without ## PARAMETERS ### -CrawledProperty + +> Applicable: FAST Server for SharePoint 2010 + The crawled property that is mapped to a managed property. ```yaml Type: CrawledProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -82,13 +84,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property to which a crawled property is mapped. ```yaml Type: ManagedProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndex.md index 557178b96..07dd17875 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndex.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataFullTextIndex --- @@ -38,7 +38,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchMetadataFullTextIndex -Name CommonSharePoint -Description "Content from the common SharePoint site." ``` @@ -50,13 +50,15 @@ See New-FASTSearchMetadataFullTextIndexMapping for details about mapping propert ## PARAMETERS ### -Description + +> Applicable: FAST Server for SharePoint 2010 + Description of the full text index, including the type of content or which connector feeds the data. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -66,13 +68,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + Name of the new full text index. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndexMapping.md index 0b0c2114a..8d979dfca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndexMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataFullTextIndexMapping.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataFullTextIndexMapping --- @@ -40,7 +40,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title $fulltextindex = Get-FASTSearchMetadataFullTextIndex -Name thirdfulltextindex @@ -54,13 +54,15 @@ After this mapping is made, the content must be re-fed to populate the full text ## PARAMETERS ### -FullTextIndex + +> Applicable: FAST Server for SharePoint 2010 + The full text index to add the mapping to. ```yaml Type: FullTextIndex Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -70,6 +72,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: FAST Server for SharePoint 2010 + The importance level of this managed property. Allowed values are 1 through 7. @@ -77,7 +82,6 @@ Allowed values are 1 through 7. Type: Int32 Parameter Sets: (All) Aliases: ImportanceLevel, L -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -87,13 +91,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property being mapped to the full text index. ```yaml Type: ManagedProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataManagedProperty.md index d7d0bc2da..cf8c1743c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataManagedProperty.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataManagedProperty --- @@ -42,7 +42,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchMetadataManagedProperty -name integervalue -type 2 -description "A managed property for integer values" ``` @@ -50,7 +50,7 @@ New-FASTSearchMetadataManagedProperty -name integervalue -type 2 -description "A This example creates a managed property called "integervalue" of type 2 (integer). To further change the settings on the managed property, see Set-FASTSearchMetadataManagedProperty. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$managedproperty = New-FASTSearchMetadataManagedProperty -Name webtitle -type 1 -description "Titles from RSS and Sitemap Files" $rsstitle = Get-FASTSearchMetadataCrawledProperty -Name rss.title @@ -73,13 +73,15 @@ To make the managed property searchable on its own, see Set-FASTSearchMetadataMa ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the new managed property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -89,6 +91,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: FAST Server for SharePoint 2010 + An integer representing the data type of the new managed property. Valid values are: @@ -102,8 +107,7 @@ Valid values are: ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -113,13 +117,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A text description of the managed property explaining what the managed property is used for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataRankProfile.md index b5ef0726c..8972a9ecf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataRankProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchMetadataRankProfile.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchMetadataRankProfile --- @@ -35,7 +35,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchMetadataRankProfile -Name newrankdistribution ``` @@ -43,7 +43,7 @@ New-FASTSearchMetadataRankProfile -Name newrankdistribution This example adds a new rank profile based on the default settings. The new rank profile is called "newrankdistribution". -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$rankprofile_template = Get-FASTSearchMetadataRankProfile -Name newrankdistribution New-FASTSearchMetadataRankProfile -Template $rankprofile_template -Name ExtraRankProfile @@ -51,7 +51,7 @@ New-FASTSearchMetadataRankProfile -Template $rankprofile_template -Name ExtraRan This example adds a new rank profile based on an existing rank profile called "newrankdistribution". -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` C:\PS>$new_rank_profile = New-FASTSearchMetadataRankProfile -Name ImprovedDefault $new_rank_profile.makeDefault() @@ -62,13 +62,15 @@ This example specifies a new rank profile to use as the default rank profile for ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the new rank profile. ```yaml Type: String Parameter Sets: (All) Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -78,13 +80,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: FAST Server for SharePoint 2010 + An object representing the rank profile that will serve as a template in creating the new rank profile. ```yaml Type: RankProfile Parameter Sets: (All) Aliases: RankProfileTemplate, T -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSearchSettingGroup.md index 6c2d96389..da927acae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSearchSettingGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSearchSettingGroup.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSearchSettingGroup --- @@ -28,7 +28,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchSearchSettingGroup -Name marketinggroup ``` @@ -38,13 +38,15 @@ This example creates a new FAST Search Server 2010 for SharePoint search setting ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the search setting group to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityClaimsUserStore.md index 23195c946..623113cdc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityClaimsUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityClaimsUserStore.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSecurityClaimsUserStore --- @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityClaimsUserStore -Identity clm ``` @@ -38,7 +38,7 @@ This example creates a new security claims user store with a user store Identity This example uses default values for all parameters except the required Identity parameter. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityClaimsUserStore -Identity clm | New-FASTSearchSecurityClaimsUserStore -Identity cl2 ``` @@ -49,13 +49,15 @@ The New-FASTSearchSecurityClaimsUserStore cmdlet uses the ObjectToClone value on ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The user store identity. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A brief explanation of the user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -Issuer + +> Applicable: FAST Server for SharePoint 2010 + The Microsoft SharePoint Server Security Token Service (STS) claims provider that issued the claims. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -ObjectToClone + +> Applicable: FAST Server for SharePoint 2010 + A claims user store object whose property values are used as a baseline to create another claims user store. ```yaml Type: ClaimsUserStore Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityLotusNotesUserStore.md index 359670ecb..6489b91d4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityLotusNotesUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityLotusNotesUserStore.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSecurityLotusNotesUserStore --- @@ -36,7 +36,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` new-FASTSearchSecurityLotusNotesUserStore ln1 ``` @@ -45,7 +45,7 @@ This example creates a new security Lotus Notes user store with a user store ide This example uses default values for all parameters except the required Identity parameter. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityLotusNotesUserStore -Identity ln1 | New-FASTSearchSecurityLotusNotesUserStore -Identity ln3 -UseViewSecurity $true ``` @@ -56,13 +56,15 @@ The New-FASTSearchSecurityLotusNotesUserStore command uses the ObjectToClone obj ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + User store identity. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -72,13 +74,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A brief explanation of the user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -UseDenyOnDefault + +> Applicable: FAST Server for SharePoint 2010 + If true, support for default access with deny on users/groups is enabled on database level security. You must enable this filter for an inverse security model: first grant access to everyone, and then explicitly deny access to certain groups or users. @@ -95,8 +102,7 @@ You must enable this filter for an inverse security model: first grant access to ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 @@ -106,6 +112,9 @@ Accept wildcard characters: False ``` ### -UseDocumentSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, item security is enabled (i.e., the filter contains an item level security condition). If set to false, item level security is ignored; only database level security (and possibly view security) is used. @@ -115,8 +124,7 @@ If items always inherit the ACLs of the database, you can turn off this option. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 @@ -126,6 +134,9 @@ Accept wildcard characters: False ``` ### -UseWildcardSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, database access through wildcard group entry (starting with */) is enabled. If set to false, the wildcard check is ignored. @@ -134,8 +145,7 @@ Only normal groups are checked against the database ACL. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 5 @@ -145,6 +155,9 @@ Accept wildcard characters: False ``` ### -UseViewSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, view security is enabled (i.e., the filter contains a view level security condition). If set to false, view level security is ignored; only database level security (and possibly item security) is used. @@ -154,8 +167,7 @@ If views always inherit the ACLs of the database, or if views are not indexed, y ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 6 @@ -165,13 +177,15 @@ Accept wildcard characters: False ``` ### -AllowPrefix + +> Applicable: FAST Server for SharePoint 2010 + A string value prepended to the document ACL to control which items the user is allowed access to and which items will be returned in the query. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 7 @@ -181,13 +195,15 @@ Accept wildcard characters: False ``` ### -DenyPrefix + +> Applicable: FAST Server for SharePoint 2010 + A string value prepended to the ACL to control which items the user is denied access to and which items are not returned from the query. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 8 @@ -197,6 +213,9 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterHandling + +> Applicable: FAST Server for SharePoint 2010 + Specifies what to do with ACL values that match the NonIndexableCharacterRegExPattern regular expression. Valid values: @@ -208,8 +227,7 @@ Valid values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9 @@ -219,13 +237,15 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterEncodingPrefix + +> Applicable: FAST Server for SharePoint 2010 + If NonIndexableCharacterHandling is set to encodeWithPrefix, this parameter specifies the prefix added to the encoded ACL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 10 @@ -235,6 +255,9 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterPattern + +> Applicable: FAST Server for SharePoint 2010 + Specifies a regular expression pattern used to detect non-indexable characters in an ACL. Identities matching this regular expression pattern will be processed based on NonIndexableCharacterHandling. @@ -242,8 +265,7 @@ Identities matching this regular expression pattern will be processed based on N ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 11 @@ -253,13 +275,15 @@ Accept wildcard characters: False ``` ### -ObjectToClone + +> Applicable: FAST Server for SharePoint 2010 + A Lotus Notes user store object whose property values are used as a baseline for the Lotus Notes user store being created. ```yaml Type: LotusNotesUserStore Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaser.md index 67dfd9163..85a69666a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaser.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSecurityRegexAliaser --- @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityRegexAliaserPattern -Regex .* -MapToUsername \1 | New-FASTSearchSecurityRegexAliaser -Identity regex1 -InputUserStoreId ln1 -OutputUserStoreIds ln2 ``` This example creates a regular expression aliaser pattern object and pipes it into a New-FASTSearchSecurityRegexAliaser cmdlet to create a regular expression aliaser. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityRegexAliaserPattern -Regex .* -MapToUsername \1 | New-FASTSearchSecurityRegexAliaser -InputUserStoreId ln1 -OutputUserStoreIds ln2,ln3 -CaseSensitive $False -UnicodeCaseSensitive $False ``` @@ -51,13 +51,15 @@ The example generates the aliaser identity. ## PARAMETERS ### -InputUserStoreId + +> Applicable: FAST Server for SharePoint 2010 + The identity of the mapped-from user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -OutputUserStoreIds + +> Applicable: FAST Server for SharePoint 2010 + A comma-separated list of mapped-to user store identities. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -Patterns + +> Applicable: FAST Server for SharePoint 2010 + A list of RegExAliasPatternMapConfig instances containing the regular expression patterns used for the mapping. ```yaml Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 3 @@ -99,13 +105,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the aliaser. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 @@ -115,14 +123,16 @@ Accept wildcard characters: False ``` ### -CaseSensitive + +> Applicable: FAST Server for SharePoint 2010 + Specifies whether the regular expression patterns defined in the RegExAliasPatternMapConfig list are matched based on case sensitivity matching rules. The default is true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 5 @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -UnicodeCaseSensitive + +> Applicable: FAST Server for SharePoint 2010 + Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on Unicode case sensitivity matching rules. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 6 @@ -148,13 +160,15 @@ Accept wildcard characters: False ``` ### -ObjectToClone + +> Applicable: FAST Server for SharePoint 2010 + A SecurityRegexAliaser object whose property values are used for the SecurityRegexAliaser aliaser being created. ```yaml Type: SecurityRegexAliaser Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaserPattern.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaserPattern.md index c19c1ac72..f7135bfae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaserPattern.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityRegexAliaserPattern.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSecurityRegexAliaserPattern --- @@ -32,7 +32,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityRegexAliaserPattern -Regex .* -InputPropertyName mail -MapToUsername "\1" ``` @@ -44,14 +44,16 @@ Use the regex pattern configuration object output from this command for the valu ## PARAMETERS ### -Regex + +> Applicable: FAST Server for SharePoint 2010 + The regular expression pattern that determines if the user or group should be mapped to another user store. This regular expression pattern may contain regular expression groups that may be used in the generation of the MapToUsername value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -MapToUsername + +> Applicable: FAST Server for SharePoint 2010 + The user or group name to look to. This can also contain regular expression group replacements using the syntax: @@ -71,8 +76,7 @@ where # is the group capture index. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -InputPropertyName + +> Applicable: FAST Server for SharePoint 2010 + The user/group property name this regular expression pattern is matched against. The InputPropertyName is one of the following: @@ -95,8 +102,7 @@ Refer to your specific user store for other properties that the user store expos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 @@ -106,14 +112,16 @@ Accept wildcard characters: False ``` ### -Patterns + +> Applicable: FAST Server for SharePoint 2010 + A list of RegExAliasPatternMapConfig objects. The RegExAliasPatternMapConfig being created is added to this list. ```yaml Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityXMLAliaser.md index 26d62755e..c8fd9d835 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityXMLAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-FASTSearchSecurityXMLAliaser.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: New-FASTSearchSecurityXMLAliaser --- @@ -30,7 +30,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityXMLAliaser -InputUserStoreId win -OutputUserStoreIds ln3 -InputPropertyName mail ``` @@ -39,7 +39,7 @@ This example creates an XML principal aliaser to map the mail property of a Micr Use the Set-FASTSearchSecurityXMLAliaser cmdlet to upload the XML mapping file. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityAliaser xmlalias2 | New-FASTSearchSecurityXMLAliaser -Identity myxmlalias -OutputUserStoreIds ln2 ``` @@ -51,13 +51,15 @@ Use the Set-FASTSearchSecurityXMLAliaser cmdlet to upload an XML mapping file wi ## PARAMETERS ### -InputUserStoreId + +> Applicable: FAST Server for SharePoint 2010 + The identity of the mapped-from user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -OutputUserStoreIds + +> Applicable: FAST Server for SharePoint 2010 + A comma-separated list of mapped-to user store identities. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 2 @@ -83,14 +87,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the aliaser. An identity is generated if the parameter is not specified. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 @@ -100,6 +106,9 @@ Accept wildcard characters: False ``` ### -InputPropertyName + +> Applicable: FAST Server for SharePoint 2010 + The user/group property name this regular expression pattern is matched against. The InputPropertyName is one of the following: @@ -118,8 +127,7 @@ Refer to your specific user store for other properties that the user store expos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 5 @@ -129,13 +137,15 @@ Accept wildcard characters: False ``` ### -ObjectToClone + +> Applicable: FAST Server for SharePoint 2010 + A SecurityXMLAliaserobject whose property values are copied as a baseline in the creation of another SecurityXMLAliaser aliaser. ```yaml Type: SecurityXMLAliaser Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServiceApplication.md index cd23a37f0..2bfacefd0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPAccessServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAccessServiceApplication @@ -35,14 +35,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1---------------- +### EXAMPLE 1 ``` New-SPAccessServiceApplication -Name "MyAccessService" -SPIisWebServiceApplicationPool MyAppPool ``` This example creates a new instance of Access Services named MyAccessService that runs under the application pool named MyAppPool. -### ------------EXAMPLE 2---------------- +### EXAMPLE 2 ``` New-SPAccessServiceApplication -Name "MyAccessService" -SPIisWebServiceApplicationPool MyAppPool -SessionsPerUserMax 25 ``` @@ -52,6 +52,9 @@ This example creates a new instance of Access Services named MyAccessService tha ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the Access Services application to create. The name can contain a maximum of 128 characters and can contain the comma (,), equal sign (=), or colon (:) characters provided they are enclosed in quotation marks. @@ -60,8 +63,7 @@ The type must be a valid name of an Access Services application; for example, Ac ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,6 +73,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing Internet Information Services (IIS) application pool to run the Web service in for the new Access Services application. The type must be a valid instance of a SPIisWebServiceApplicationPool object. @@ -78,8 +83,7 @@ The type must be a valid instance of a SPIisWebServiceApplicationPool object. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +107,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +117,9 @@ Accept wildcard characters: False ``` ### -CacheTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of seconds that a data cache will remain active on Access Services with no user activity. Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. @@ -120,8 +129,7 @@ The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +139,9 @@ Accept wildcard characters: False ``` ### -ColumnsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of columns that a list involved in a query can contain, or that the output of the query can contain. The default value is 30. @@ -139,8 +150,7 @@ The type must be an integer in the range of 1 to 255 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +160,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -157,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -167,13 +179,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application is associated with Web applications by adding this service application's proxy to the farm's default proxy list. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +197,15 @@ Accept wildcard characters: False ``` ### -NonRemotableQueriesAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that queries that cannot be remoted to the database tier can run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +215,9 @@ Accept wildcard characters: False ``` ### -OrderByMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of Order By clauses in the query. The default value is 4. @@ -207,8 +226,7 @@ The type must be an integer in the range of 1 to 8. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -218,14 +236,16 @@ Accept wildcard characters: False ``` ### -OuterJoinsAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that left and right outer joins are supported. Inner joins are always supported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,6 +255,9 @@ Accept wildcard characters: False ``` ### -OutputCalculatedColumnsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of calculated columns that can be included in the output as a part of the query. Calculated columns in the underlying list are not included. The default value is 10. @@ -244,8 +267,7 @@ The type must be an integer in the range of 1 to 32. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -255,6 +277,9 @@ Accept wildcard characters: False ``` ### -PrivateBytesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum private bytes in megabytes (MB) that can be used by Access Services. When set to -1, Access Services defaults to 75 percent of physical memory on the machine. Valid values are -1 (no limit), and from 1 to any positive integer.The default value is -1. @@ -262,8 +287,7 @@ Valid values are -1 (no limit), and from 1 to any positive integer.The default v ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,6 +297,9 @@ Accept wildcard characters: False ``` ### -RecordsInTableMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of records allowed for a table in the Access Services application. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 500000. @@ -282,8 +309,7 @@ The type must be the integer -1, or an integer in the range of 1 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -293,6 +319,9 @@ Accept wildcard characters: False ``` ### -RequestDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. The default value is 30. @@ -302,8 +331,7 @@ The type must be the integer -1, or an integer in the range of 1 to 2073600 (24 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -313,6 +341,9 @@ Accept wildcard characters: False ``` ### -RowsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of rows that a list involved in a query can have, or that the output of the query can have. The default value is 50000. @@ -321,8 +352,7 @@ The type must be an integer in the range of 1 to 200000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -332,6 +362,9 @@ Accept wildcard characters: False ``` ### -SessionMemoryMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum allowable size, in megabytes, of an individual session. Valid values include 0, disable property, and 1 to 4095. The default value is 64. @@ -341,8 +374,7 @@ The type must be the integer 0, or an integer in the range of 1 to 4095. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -352,6 +384,9 @@ Accept wildcard characters: False ``` ### -SessionsPerAnonymousUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of sessions allowed per user. If this maximum is reached, the oldest session will be deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. @@ -362,8 +397,7 @@ The type must be the integer -1, or an integer in the range of 1 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -373,6 +407,9 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of sessions allowed per user. If this maximum is reached, the oldest session will be deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. @@ -383,8 +420,7 @@ The type must be the integer -1, or an integer in the range of 1 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -394,6 +430,9 @@ Accept wildcard characters: False ``` ### -SourcesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of lists that can be used as input to a query at one time. The default value is 8. @@ -402,8 +441,7 @@ The type must be an integer in the range of 1 to 20. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -413,14 +451,16 @@ Accept wildcard characters: False ``` ### -TemplateSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum allowable size in megabytes allowed for Access templates (.accdt file files) uploaded into the solution gallery. Valid values: -1(no limit), from 1 to any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -430,6 +470,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -437,7 +480,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -447,13 +489,15 @@ Accept wildcard characters: False ``` ### -ApplicationLogSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of records for an Access Services Application Log list. Valid valies: -1 to maxint. 0 means none are allowed. The default value is 3000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplication.md index 2823e56ba..2ff2715ea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplication.md @@ -7,7 +7,7 @@ title: New-SPAccessServicesApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAccessServicesApplication @@ -41,7 +41,7 @@ Creates an Access Services Service Application. ## EXAMPLES -### Example 1 +### Example 1 ``` New-SPAccessServicesApplication -DatabaseServer SQLServerName -ApplicationPool 'SharePoint Web Services Default' -Name 'Access Services Service Application' -Default ``` @@ -51,6 +51,9 @@ Creates an Access Services Service Application. ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -58,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -76,8 +81,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,15 +91,17 @@ Accept wildcard characters: False ``` ### -CacheTimeout + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum time (in seconds) that a data cache can remain available, as measured from the end of each request for data in that cache. -Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). - +Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). + ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,13 +111,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,6 +129,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SERVER\Database. @@ -128,8 +139,7 @@ The type must be a valid SQL Server host name; for example, SERVER\Database. ```yaml Type: String Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -139,13 +149,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials used to log into the database server. ```yaml Type: PSCredential Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +167,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Add to default Service Application Proxy group. ```yaml Type: SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: DefaultParameterSet, NoApplicationServerParameterSet +Aliases: Required: True Position: Named @@ -170,27 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: NoApplicationServerParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -Encrypt -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -Encrypt Specifies to use SSL encryption between Access Services and the SQL Server hosting Access Services databases. ```yaml Type: Boolean Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,13 +204,14 @@ Accept wildcard characters: False ### -Hosted +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Not used. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -217,13 +221,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Access Services Service Application to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -233,15 +239,17 @@ Accept wildcard characters: False ``` ### -PrivateBytesMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of private bytes (in MB) allocated by the Access Services process. -Valid values: -1 (the limit is set to 50% of physical memory on the machine), any positive integer. +Valid values: -1 (the limit is set to 50% of physical memory on the machine), any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -251,6 +259,9 @@ Accept wildcard characters: False ``` ### -QueryTimeout + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Maximum time in seconds for a database command or query to execute before it is cancelled. Valid values: 0 (indicates no limit); 1 through 2073600 (24 days). Recommended value is 60. @@ -258,8 +269,7 @@ Valid values: 0 (indicates no limit); 1 through 2073600 (24 days). Recommended v ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -270,13 +280,14 @@ Accept wildcard characters: False ### -RecoveryPointObjective +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Not used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -286,15 +297,17 @@ Accept wildcard characters: False ``` ### -RequestDurationMax -The maximum duration (in seconds) allowed for a request from an application. -Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The maximum duration (in seconds) allowed for a request from an application. + +Valid values: -1 (indicates no limit); 1 through 2073600 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -304,15 +317,17 @@ Accept wildcard characters: False ``` ### -SessionsPerAnonymousUserMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of sessions allowed per anonymous user. If this maximum is hit the oldest session will be deleted when a new session is started. -Valid values: -1 (no limit), 1 to any positive integer. +Valid values: -1 (no limit), 1 to any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -322,15 +337,17 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax -The maximum number of sessions allowed per user. If a user has this many sessions and starts a new session, the user's oldest session is deleted. -Valid values: -1 (no limit), from 1 to any positive integer. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The maximum number of sessions allowed per user. If a user has this many sessions and starts a new session, the user's oldest session is deleted. + +Valid values: -1 (no limit), from 1 to any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -340,13 +357,15 @@ Accept wildcard characters: False ``` ### -TrustServerCertificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust. ```yaml Type: Boolean Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -356,6 +375,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -363,7 +385,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplicationProxy.md index 65664ceab..22e9bdee0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPAccessServicesApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAccessServicesApplicationProxy @@ -26,7 +26,7 @@ New-SPAccessServicesApplicationProxy [-application] Creates a Proxy for an Access Services Service Application. ## EXAMPLES -### Example 1 +### Example 1 ``` $sa = New-SPAccessServicesApplication -DatabaseServer spag.lab.cobaltatom.com -ApplicationPool 'SharePoint Web Services Default' -Name 'Access Services Service Application' -Default New-SPAccessServicesApplicationProxy -application $sa @@ -37,6 +37,9 @@ This example creates an Access Services Application, placing it into the `$sa` v ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,6 +75,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -78,7 +85,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -application + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Access Services Service Application to create a proxy for. ```yaml Type: SPServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesDatabaseServer.md index 59afb076d..320f0af14 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesDatabaseServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAccessServicesDatabaseServer.md @@ -7,7 +7,7 @@ title: New-SPAccessServicesDatabaseServer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAccessServicesDatabaseServer @@ -32,7 +32,7 @@ This cmdlet adds additional Access Services database servers to host Access Serv ## EXAMPLES -### Example 1 +### Example 1 ``` New-SPAccessServicesDatabaseServer -ServiceContext https://siteUrl -DatabaseServerName SQLSVR01 -ValidateServer:$true ``` @@ -42,6 +42,9 @@ This example adds the SQL Server named SQLSVR01 as an Access Services database s ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +52,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -60,13 +62,15 @@ Accept wildcard characters: False ``` ### -AvailableForCreate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates whether or not the SQL Server is available to create Access Services databases on. The default value is true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +80,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -92,13 +98,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials used to connect to the SQL Server. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,13 +116,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroupName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Access Services database group name. The default value is DEFAULT. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +134,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SQL Server to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -140,13 +152,15 @@ Accept wildcard characters: False ``` ### -Encrypt + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to use SSL encryption between Access Services and the SQL Server hosting Access Services databases. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +170,15 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If the SQL Server has AvaliableForCreate set to False, this will update it to True. If the SQL Server Id does not match the database server Id and the server has AvailableForCreate set to True, this will set AvailableForCreate to False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +188,15 @@ Accept wildcard characters: False ``` ### -SecondaryDatabaseServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a secondary SQL Server to associate to the new SQL Server. This is used for disaster recovery purposes. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +206,15 @@ Accept wildcard characters: False ``` ### -ServerReferenceId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Provide a specific Server Reference Id. By default, a Server Reference Id is generated automatically when the SQL Server is added. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +224,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context to retrieve Access Services information from. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -220,13 +242,15 @@ Accept wildcard characters: False ``` ### -TrustServerCertificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +260,15 @@ Accept wildcard characters: False ``` ### -UserDomain + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the domain to use for credentials. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,13 +278,15 @@ Accept wildcard characters: False ``` ### -ValidateServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Validates the SQL Server is in a supported state to host Access Services databases. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +296,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -275,7 +306,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -285,13 +315,16 @@ Accept wildcard characters: False ``` ### -LoginType + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Indicates the login type. Valid values are: -* ApplicationLogin +* ApplicationLogin -* LocalDBApplicationLogin +* LocalDBApplicationLogin -* ServerLogin +* ServerLogin * StorageAccountLogon @@ -302,9 +335,8 @@ The default value is ServerLogin. ```yaml Type: LoginType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: ApplicationLogin, LocalDBApplicationLogin, ServerLogin, StorageAccountLogon, WindowsAzureServerLogin -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -314,6 +346,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Indicates the availability of the SQL Server to be added. Valid values are: * Active @@ -327,9 +362,8 @@ The default value is Active. ```yaml Type: DatabaseServerStates Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Active, Locked, Reserved -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -339,6 +373,9 @@ Accept wildcard characters: False ``` ### -StateOwner + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the state owner. Valid values are: * NoOwner @@ -350,9 +387,8 @@ The default value is NoOwner. ```yaml Type: ServerStateOwner Parameter Sets: (All) -Aliases: +Aliases: Accepted values: NoOwner, TenantMove -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAlternateURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAlternateURL.md index 246ebb6a9..b1dc9b0db 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAlternateURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAlternateURL.md @@ -7,7 +7,7 @@ title: New-SPAlternateURL schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAlternateURL @@ -17,7 +17,6 @@ ms.reviewer: Creates a new public or internal URL for the specified Web application zone or resource. - ## SYNTAX ### WebApplication @@ -54,7 +53,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` #create the public URL New-SPAlternateURL https://www.contoso.com -Zone "Internet" @@ -70,6 +69,9 @@ When a reverse proxy is being set up to handle public URL SSL termination, alter ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the public URL that users access to sign in to the Web application. The type must be a valid URL, in the form https://server_name. @@ -77,8 +79,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name, URL, or GUID of the Web application for which to create the mapping. The type must be a valid name, URL, in the form WebApplication-1212, https://server_name, or GUID, in the form 1234-5678-9876-0987. @@ -95,8 +99,7 @@ The type must be a valid name, URL, in the form WebApplication-1212, https://ser ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -106,14 +109,16 @@ Accept wildcard characters: False ``` ### -ResourceName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the resource name, if the alternate URL is for an external resource. If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,8 +142,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +162,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -162,14 +171,16 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Makes this alternate URL an internal URL. If this parameter is not provided, the URL is a public URL. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -186,7 +200,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the five zones with which the alternate URL is associated. The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom. @@ -203,8 +219,7 @@ The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom. ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplication.md index 4ee4e4c8b..26ba828ca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPAppManagementServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAppManagementServiceApplication @@ -17,7 +17,6 @@ ms.reviewer: Creates an App Management Service application. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE---------- +### EXAMPLE ``` New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool ``` @@ -45,13 +44,15 @@ The new service application will run under the app pool named MyServiceAppPool ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application pool of the service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials to use when creating the service application database. These credentials will have owner rights on the newly created service application database. If a value is not provided, the current user's credentials are used by default. @@ -107,8 +115,7 @@ If a value is not provided, the current user's credentials are used by default. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,14 +125,16 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application database to be created. If a value is not provided, a default database name is provided. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server of the service application database to be created, If a value is not provided, the default database server is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the failover server of the service application database to be created, If a value is not provided, there will not be a failover server for the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +180,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application to be created. If not provided, the default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +199,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -191,7 +209,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplicationProxy.md index efe00dbca..a18706f14 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAppManagementServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPAppManagementServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAppManagementServiceApplicationProxy @@ -17,7 +17,6 @@ ms.reviewer: Creates an App Management Service application proxy. - ## SYNTAX ### ServiceApplication @@ -45,7 +44,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ``` $sa = New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool New-SPAppManagementServiceApplicationProxy -Name AppManagementProxy -UseDefaultProxyGroup -ServiceApplication $sa @@ -56,13 +55,15 @@ This example creates a new App Management Service application proxy named AppMan ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the App Management Service application for which you are creating the service application proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the endpoint URI of the App Management Service application in which to create the service application proxy. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +105,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,14 +134,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application proxy to be created. If a value is not provided, a default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -UseDefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to add the newly created service application proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -167,7 +181,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAuthenticationProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAuthenticationProvider.md index 5d9b45e99..936e43e5a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAuthenticationProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAuthenticationProvider.md @@ -7,7 +7,7 @@ title: New-SPAuthenticationProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAuthenticationProvider @@ -17,7 +17,6 @@ ms.reviewer: Creates a new authentication provider in the farm. - ## SYNTAX ### Forms @@ -55,7 +54,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------------EXAMPLE1------------------ +### ---------------------------EXAMPLE1------------------ ``` $ap = New-SPAuthenticationProvider -UseWindowsIntegratedAuthentication Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -63,7 +62,7 @@ Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App This example creates a Windows claims authentication provider. -### ---------------------------EXAMPLE2------------------ +### ---------------------------EXAMPLE2------------------ ``` $ap = New-SPAuthenticationProvider -ASPNETMembershipProvider "membership" -ASPNETRoleProviderName "rolemanager" Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -71,7 +70,7 @@ Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App This example creates an authentication provider that is based on the ASP.NET membership role provider. -### ---------------------------EXAMPLE3------------------ +### ---------------------------EXAMPLE3------------------ ``` $ap = New-SPAuthenticationProvider -TrustedIdentityTokenIssuer | Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -82,6 +81,9 @@ This example creates a trusted token issuer authentication provider. ## PARAMETERS ### -ASPNETMembershipProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the membership provider. The value must be a valid name of an ASP.NET membership provider; for example, myMembershipProvider. @@ -89,8 +91,7 @@ The value must be a valid name of an ASP.NET membership provider; for example, m ```yaml Type: String Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +101,9 @@ Accept wildcard characters: False ``` ### -ASPNETRoleProviderName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the role provider. The value must be a valid name of an ASP.NET role provider; for example, myRoleProvider. @@ -107,8 +111,7 @@ The value must be a valid name of an ASP.NET role provider; for example, myRoleP ```yaml Type: String Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +121,9 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the authentication provider. The value must be in one of the following forms: @@ -129,8 +135,7 @@ The value must be in one of the following forms: ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: Trusted -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -140,13 +145,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymous + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the web application allows anonymous access. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -167,8 +177,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -DisableKerberos + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the web application disables Kerberos authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,13 +205,15 @@ Accept wildcard characters: False ``` ### -UseBasicAuthentication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the web application uses Basic authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -UseWindowsIntegratedAuthentication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the web application uses Integrated Windows authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAzureAccessControlServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAzureAccessControlServiceApplicationProxy.md index e6955ad02..e523a0bf2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAzureAccessControlServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPAzureAccessControlServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPAzureAccessControlServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPAzureAccessControlServiceApplicationProxy @@ -17,7 +17,6 @@ ms.reviewer: Creates a new service application proxy group. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ``` New-SPAzureAccessControlServiceApplicationProxy -Name "ACS" -metadataEndpointUri "http://test" -DefaultProxyGroup ``` @@ -43,13 +42,15 @@ This example creates a proxy group named ACS which will be added to the default ## PARAMETERS ### -MetadataServiceEndpointUri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the Azure Access Control Service's metadata document. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the proxy that you want to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the proxy needs to be added to the default proxy group. We recommend that you add the proxy to the default proxy group. @@ -121,8 +131,7 @@ We recommend that you add the proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBECWebServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBECWebServiceApplicationProxy.md index 772e98db1..14ffd1c9b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBECWebServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBECWebServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPBECWebServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPBECWebServiceApplicationProxy @@ -37,13 +37,15 @@ For permissions and the most current information about Windows PowerShell for Sh ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -69,13 +73,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,13 +91,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -101,13 +109,15 @@ Accept wildcard characters: False ``` ### -ServiceEndpointUri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -117,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -124,7 +137,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplication.md index 420c8d919..b87ff611c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPBusinessDataCatalogServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPBusinessDataCatalogServiceApplication @@ -17,7 +17,6 @@ ms.reviewer: Creates a new Business Data Connectivity service application in the farm. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" ``` @@ -46,13 +45,15 @@ In this process it uses the SharePoint Web Services Default application pool and ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS application pool to use for the new Business Data Connectivity service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name for the Business Data Connectivity database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SERVER\Database. @@ -85,8 +91,7 @@ The type must be a valid SQL Server host name; for example, SERVER\Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a display name for the new Business Data Connectivity service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +133,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -158,8 +172,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +182,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -177,8 +193,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,14 +203,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,13 +222,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -221,6 +240,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. @@ -229,8 +251,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -240,13 +261,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Business Data Connectivity application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +279,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -263,7 +289,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -273,13 +298,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplicationProxy.md index cf3028f4b..7cdd4eabf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPBusinessDataCatalogServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPBusinessDataCatalogServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPBusinessDataCatalogServiceApplicationProxy @@ -43,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $sa = New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" New-SPBusinessDataCatalogServiceApplicationProxy -Name "ContosoServiceAppProxy" -ServiceApplication $sa @@ -54,13 +54,15 @@ This example creates a new Business Data Connectivity service application proxy ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a display name for the new Business Data Connectivity service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of a remote service application to which to connect. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -93,8 +100,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -115,8 +124,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -133,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -143,13 +153,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application proxy is added to the default proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +171,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -166,7 +181,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -176,6 +190,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if partition mode is to be turned on. The valid values are True and False. The default value is False. @@ -183,8 +200,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPCentralAdministration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPCentralAdministration.md index b76accdff..e6eef7895 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPCentralAdministration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPCentralAdministration.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new SharePoint Central Administration Web application. - ## SYNTAX ``` @@ -30,25 +29,26 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPCentralAdministration -WindowsAuthProvider NTLM -Port 8080 ``` This example creates the Central Administration site at port 8080 on the local farm using NTLM authentication. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` New-SPCentralAdministration -WindowsAuthProvider Kerberos -Port 443 -SecureSocketsLayer ``` This example creates the Central Administration site using SSL on port 443 with Kerberos authentication. - ## PARAMETERS ### -Port + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the port number for Central Administration. If no port is specified, a nonconflicting port number is auto-generated. @@ -59,8 +59,7 @@ If you specify a port number that has already been assigned, IIS does not start ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authorization provider for this Web application. If no authentication provider is specified, the default value NTLM is used. @@ -78,8 +80,7 @@ The type must be one of two values: Kerberos or NTLM. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 2 @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +104,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Enables Secure Socket Layer (SSL) encryption for the specified port. If you choose to use SSL, you must assign a server certificate to the Central Administration IIS web site by using the IIS administration tools. The Central Administration web application won't be accessible until you do this. The default value is False. @@ -120,8 +126,7 @@ If this parameter is omitted or set to False the Central Administration site wil ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimProvider.md index c06f86950..8b7b3dcef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimProvider.md @@ -7,7 +7,7 @@ title: New-SPClaimProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPClaimProvider @@ -17,7 +17,6 @@ ms.reviewer: Registers a new claim provider in the farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` New-SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -Default ``` @@ -42,6 +41,9 @@ This example registers a claim provider to all Web applications and zones. ## PARAMETERS ### -AssemblyName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid name of an assembly; for example, ClaimAssembly1. Specifies the name of the assembly with the claim provider. @@ -49,8 +51,7 @@ Specifies the name of the assembly with the claim provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the claim provider. The type must be a valid name of an assembly; for example, ClaimAssembly1. @@ -67,8 +71,7 @@ The type must be a valid name of an assembly; for example, ClaimAssembly1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the new claim provider. The type must be a valid name of a claim provider; for example, ClaimProvider1. @@ -85,8 +91,7 @@ The type must be a valid name of a claim provider; for example, ClaimProvider1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of the claim. The type must be a valid name of a claim type; for example MyClaimProvider.Providers.CustomProvider. @@ -103,8 +111,7 @@ The type must be a valid name of a claim type; for example MyClaimProvider.Provi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -114,6 +121,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -125,8 +135,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the claim provider applies to all Web applications and zones. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on the claim provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeEncoding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeEncoding.md index 26bfb1bd3..8cf6a7e12 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeEncoding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeEncoding.md @@ -7,7 +7,7 @@ title: New-SPClaimTypeEncoding schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPClaimTypeEncoding @@ -17,7 +17,6 @@ ms.reviewer: Registers a new type of claim. - ## SYNTAX ``` @@ -41,10 +40,9 @@ For more information about the SPClaim methods and properties, see M:Microsoft.S For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ``` New-SPClaimTypeEncoding -EncodingCharacter '1' -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" ``` @@ -54,13 +52,15 @@ This example registers a new type of claim. ## PARAMETERS ### -ClaimType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of claim for which you want to create a mapping. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,13 +70,15 @@ Accept wildcard characters: False ``` ### -EncodingCharacter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Unicode character to which you want to create a mapping. ```yaml Type: Char Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -125,13 +131,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses confirmation messages to any claim type that is added. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeMapping.md index 99558d9c9..06fa5a322 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimTypeMapping.md @@ -7,7 +7,7 @@ title: New-SPClaimTypeMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPClaimTypeMapping @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1---------------------------- +### EXAMPLE 1 ``` $map1 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming $map2 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" @@ -43,6 +43,9 @@ This example creates a claim map from an incoming token to a SharePoint token. ## PARAMETERS ### -IncomingClaimType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the incoming claim type. The type must be a valid URI, in the form http://schemas.microsoft.com/email. @@ -50,8 +53,7 @@ The type must be a valid URI, in the form http://schemas.microsoft.com/email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -IncomingClaimTypeDisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the incoming claim type. The type must be a valid name of an incoming claim type; for example, Email. @@ -68,8 +73,7 @@ The type must be a valid name of an incoming claim type; for example, Email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -LocalClaimType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the local claim type. If the SameAsIncoming parameter is False, this is a required parameter. @@ -87,8 +94,7 @@ The type must be a valid URI, in the form http://schemas.microsoft.com/email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 3 @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +118,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +128,15 @@ Accept wildcard characters: False ``` ### -SameAsIncoming + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the claim type specified in the IncomingClaimType parameter is used for the LocalClaimType parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimsPrincipal.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimsPrincipal.md index 836e68210..b8fc4985f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimsPrincipal.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPClaimsPrincipal.md @@ -7,7 +7,7 @@ title: New-SPClaimsPrincipal schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPClaimsPrincipal @@ -17,7 +17,6 @@ ms.reviewer: Creates a claims principal. - ## SYNTAX ### STSIdentity @@ -62,28 +61,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ``` New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal contoso\johndoe -TrustedIdentityTokenIssuer "NTLM") ``` This example creates a claim principal for a Windows user. -### -------------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ``` New-SPSite https://localhost/sites/newsite -owner (New-SPClaimsPrincipal contoso\allusers -TrustedIdentityTokenIssuer "NTLM") ``` This example creates a claim principal for a Windows group. -### -------------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ``` New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal -ClaimValue "john@contoso.com" -ClaimType Email -TrustedIdentityTokenIssuer "LiveID STS" -IdentifierClaim Yes) ``` This example creates a claim principal for a trusted identity token issuer claim. -### -------------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ``` $ip = New-SPIdentityProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider" New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@contoso.com" -TrustedIdentityTokenIssuer $ip) @@ -91,14 +90,14 @@ New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@co This example creates a claim principal for a ASPNet Membership User. -### -------------------------EXAMPLE 5----------------------------- +### EXAMPLE 5 ``` New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "Sales Manager Role" -IdentityProvider "myRoleProvider") ``` This example creates a claim principal for a ASPNet Role. -### -------------------------EXAMPLE 6----------------------------- +### EXAMPLE 6 ``` $cp = New-SPClaimsPrincipal -Identity "redmond\SiteOwner" -IdentityType 1 New-SPSite https://servername:port -OwnerAlias $cp.ToEncodedString() -Template "STS#0" @@ -109,6 +108,9 @@ This example creates a claim principal for a Basic Claim Role, which is also cal ## PARAMETERS ### -ClaimValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claim value of the claims object. The claims value specifies the user, group, or computer that the claim is authenticating. @@ -117,8 +119,7 @@ The type must be a valid claim value; for example, john@contoso.com. ```yaml Type: String Parameter Sets: STSIdentity, ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -128,6 +129,9 @@ Accept wildcard characters: False ``` ### -EncodedClaim + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Converts a simple claim to a full encoded claim. The type must be a valid claim value; for example, i:001w|redmond\user. @@ -135,8 +139,7 @@ The type must be a valid claim value; for example, i:001w|redmond\user. ```yaml Type: String Parameter Sets: BasicClaim -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new claims principal. The type must be a valid name of a claims principal. @@ -153,8 +159,7 @@ The type must be a valid name of a claims principal. ```yaml Type: String Parameter Sets: IdentityType, TrustIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -164,6 +169,9 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of claim to create. The value I indicates a unique user identity claim, and the value C indicates all other claims. @@ -171,9 +179,8 @@ The type must be either of the following values: I or C. ```yaml Type: String -Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: STSIdentity, ClaimProvider +Aliases: Required: False Position: 2 @@ -182,20 +189,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -TrustedIdentityTokenIssuer -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -TrustedIdentityTokenIssuer Specifies the ID of the authentication provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an Authentication provider (for example, MyAuthprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. @@ -203,8 +200,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: STSIdentity, TrustIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -214,6 +210,9 @@ Accept wildcard characters: False ``` ### -IdentityType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of the new claims principal. The type must be one of the following: WindowsSamAccountName, WindowsSecurityGroupSid, FormsUser, FormsRole, or EncodedClaim. @@ -221,8 +220,7 @@ The type must be one of the following: WindowsSamAccountName, WindowsSecurityGro ```yaml Type: SPIdentifierTypes Parameter Sets: IdentityType -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -232,13 +230,15 @@ Accept wildcard characters: False ``` ### -IdentifierClaim + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the new claim is an identity claim. ```yaml Type: SwitchParameter Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 4 @@ -248,6 +248,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -259,8 +262,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -270,6 +272,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the security token service identity provider that will contain the claims principal. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. @@ -277,8 +282,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProvider Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPConfigurationDatabase.md index 83aeb569b..a7893bbda 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPConfigurationDatabase.md @@ -7,7 +7,7 @@ title: New-SPConfigurationDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPConfigurationDatabase @@ -17,7 +17,6 @@ ms.reviewer: Creates a new configuration database. - ## SYNTAX ``` @@ -37,21 +36,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) ``` This example prompts the user to provide user credentials for the default Farm Administrator account. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -SkipRegisterAsDistributedCacheHost ``` This example prompts the user to provide user credentials for the default Farm Administrator account and skips registering the server as Distributed Cache host. Applies to SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 only. -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -LocalServerRole Custom ``` @@ -61,13 +60,15 @@ This example prompts the user to provide user credentials for the default Farm A ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new configuration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -77,14 +78,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server on which to create the configuration database. If no value is specified, the default value is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +97,16 @@ Accept wildcard characters: False ``` ### -DirectoryDomain + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the directory domain for the new farm. If no domain is specified, the domain in which the local computer is located is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 3 @@ -111,14 +116,16 @@ Accept wildcard characters: False ``` ### -DirectoryOrganizationUnit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the directory organizational unit for the new configuration database. If no organizational unit is specified, the organizational unit in which the local computer is located is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 4 @@ -128,14 +135,16 @@ Accept wildcard characters: False ``` ### -AdministrationContentDatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name for the Central Administration content database for the new farm. If no name is specified, a default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 5 @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Credential object for the database user. Use this parameter if you use SQL Server Authentication. If no database credentials are provided, Windows authentication is used. @@ -152,8 +164,7 @@ If no database credentials are provided, Windows authentication is used. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 6 @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -FarmCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies credentials for the Farm Administrator account. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 7 @@ -179,14 +192,16 @@ Accept wildcard characters: False ``` ### -Passphrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the secure password phrase for the new farm. This passphrase is used to join other machines to this farm. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 8 @@ -196,6 +211,9 @@ Accept wildcard characters: False ``` ### -SkipRegisterAsDistributedCacheHost + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). Use this parameter to not register the server computer as a distributed cache host. @@ -204,8 +222,7 @@ If you want to have a dedicated cache host, then use this parameter to make sure ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 9 @@ -215,6 +232,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -226,8 +246,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,13 +256,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailOverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server Database Mirror partner server for the Configuration and Central Administration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -253,6 +274,9 @@ Accept wildcard characters: False ``` ### -LocalServerRole + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the Server Role. Valid options for all versions of SharePoint Server 2016, SharePoint Server 2019 are: `Custom`, `SingleServerFarm`, `Application`, `WebFrontEnd`, `DistributedCache`, `Search` @@ -262,8 +286,7 @@ With the addition of Feature Pack 1, new options include: ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,13 +296,15 @@ Accept wildcard characters: False ``` ### -ServerRoleOptional + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -289,13 +314,15 @@ Accept wildcard characters: False ``` ### -SiteMapDatabaseName + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. Specifies the database name of the Site Map site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -305,13 +332,15 @@ Accept wildcard characters: False ``` ### -SiteMapDatabaseServer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. Specifies the database server name of the Site Map site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDatabase.md index 3f057756c..2cf6e29a5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDatabase.md @@ -7,7 +7,7 @@ title: New-SPContentDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPContentDatabase @@ -17,7 +17,6 @@ ms.reviewer: Creates a new content database and attaches it to the specified Web application. - ## SYNTAX ``` @@ -35,7 +34,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------------- +### EXAMPLE ``` New-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename ``` @@ -45,6 +44,9 @@ This example creates a new content database for the sitename Web application. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new content database to create within the farm. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -52,8 +54,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Attaches the content database to the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -70,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -AssignNewDatabaseId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Creates a new database ID automatically when the content database is attached. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -ClearChangeLog + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Clears any pending changes from the change log in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -159,8 +173,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +183,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the content database specified in the Name parameter. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -177,8 +193,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +203,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of Web sites that can use the content database. The type must be a positive integer. @@ -195,8 +213,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -213,8 +233,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +243,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -231,7 +253,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -ChangeSyncKnowledge + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies Groove sync client to resync their content when a Content Database attach is used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -DatabaseAccessCredentials + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the credential for the SPDataAccess role. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,13 +298,15 @@ Accept wildcard characters: False ``` ### -UseLatestSchema + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to use the latest schema. In an on-premises environment, this parameter will have no effect at all. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentJob.md index 8a0f924e0..b3a2cba87 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentJob.md @@ -7,7 +7,7 @@ title: New-SPContentDeploymentJob schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPContentDeploymentJob @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Deployment Job" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false ``` @@ -44,6 +44,9 @@ The job is configured to be an incremental job with no schedule. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new content deployment job. The type must be a valid name of a content deployment job; for example, DeployJob1. @@ -51,8 +54,7 @@ The type must be a valid name of a content deployment job; for example, DeployJo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -SPContentDeploymentPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the deployment path to associate with the new deployment job. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +127,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description for the content deployment job. The name can be a maximum of 4096 alphanumeric characters. @@ -127,8 +138,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +148,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. The type must be a list of valid e-mail addresses. @@ -145,8 +158,7 @@ The type must be a list of valid e-mail addresses. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +168,9 @@ Accept wildcard characters: False ``` ### -EmailNotifications + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies how e-mail notifications are sent about this ContentDeploymentJob object. The type must be one of the following: @@ -169,8 +184,7 @@ The type must be one of the following: ```yaml Type: ContentDeploymentNotificationSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +194,9 @@ Accept wildcard characters: False ``` ### -HostingSupportEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables special hosting- behavior. The default value is False. @@ -190,8 +207,7 @@ Therefore, when the HostingSupportEnabled parameter is set to True, the hoster c ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,13 +217,15 @@ Accept wildcard characters: False ``` ### -IncrementalEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only incremental changes are deployed to the destination site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +235,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the schedule for the deployment job. The type must be a valid SPSchedule object. @@ -224,8 +245,7 @@ The type must be a valid SPSchedule object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,14 +255,16 @@ Accept wildcard characters: False ``` ### -ScheduleEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to enable the schedule for the deployment job. If the schedule is not enabled the job can be run only manually. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,6 +274,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the scope of the deployment job. SPSites passed in must exist in the current path of the source site collection. The default scope is the entire site collection. @@ -262,8 +287,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,6 +297,9 @@ Accept wildcard characters: False ``` ### -SqlSnapshotSetting + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Creates a database snapshot of the source SharePoint Foundation content database to use for the export process. The type must be one of the following values: @@ -285,8 +312,7 @@ The CreateNew value requires thatSQL Server Enterprise Edition be installed. ```yaml Type: ContentDeploymentSqlSnapshotSetting Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -296,6 +322,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -303,7 +332,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentPath.md index ce2a0c108..930e2d066 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPContentDeploymentPath.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------------- +### EXAMPLE ``` C:\PS>$source = Get-SPSite "http://source/" @@ -46,6 +46,9 @@ The path is enabled and configured to keep temporary files on job failure. ## PARAMETERS ### -DestinationCentralAdministrationURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Central Administration URL for the destination farm. The type must be a valid URL, in the form http://server_name. @@ -53,8 +56,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -DestinationSPSite + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the destination site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. @@ -71,8 +76,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -DestinationSPWebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the destination Web application. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -89,8 +96,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +106,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new content deployment path. The type must be a valid name of a content deployment path; for example, DeployPath1. @@ -107,8 +116,7 @@ The type must be a valid name of a content deployment path; for example, DeployP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -PathAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user ID that is an administrator on the Central Administration page on the destination farm. The type must be a valid SharePoint user. @@ -125,8 +136,7 @@ The type must be a valid SharePoint user. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -136,6 +146,9 @@ Accept wildcard characters: False ``` ### -SourceSPSite + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the source site collection for the deployment path. Must be a site collection in the source specified in the SourceSPWebApplication parameter. @@ -144,8 +157,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -155,6 +167,9 @@ Accept wildcard characters: False ``` ### -SourceSPWebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the source Web application for the deployment path. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -162,8 +177,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -173,6 +187,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -184,8 +201,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -195,6 +211,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. The type must be one of the following values: WindowsAuth or BasicAuth. @@ -202,8 +221,7 @@ The type must be one of the following values: WindowsAuth or BasicAuth. ```yaml Type: PathAuthenticationOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +231,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on compression during the export. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +249,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -236,7 +259,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -246,6 +268,9 @@ Accept wildcard characters: False ``` ### -DeploySecurityInformation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user and group information to include during the export operation for this content deployment path. The default value is All. @@ -257,8 +282,7 @@ No user information defined in the DAP or LDAP servers is included. ```yaml Type: SPIncludeSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +292,9 @@ Accept wildcard characters: False ``` ### -DeployUserNamesEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to include user names during a deployment. Valid values are one of the following: @@ -278,8 +305,7 @@ Valid values are one of the following: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -289,6 +315,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the description for the content deployment path. The description can contain a maximum of 4096 alphanumeric characters. @@ -297,8 +326,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -308,13 +336,15 @@ Accept wildcard characters: False ``` ### -EventReceiversEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -324,6 +354,9 @@ Accept wildcard characters: False ``` ### -KeepTemporaryFilesOptions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that temporary files are kept after content deployment is finished. The type must be one of the following values: Never, Always, or OnFailure. @@ -331,8 +364,7 @@ The type must be one of the following values: Never, Always, or OnFailure. ```yaml Type: TemporaryFilesOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,13 +374,15 @@ Accept wildcard characters: False ``` ### -PathEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables the new content deployment path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -358,6 +392,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -365,7 +402,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEduClass.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEduClass.md index 1fd88610a..613bd81c5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEduClass.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEduClass.md @@ -7,7 +7,7 @@ title: New-SPEduClass schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEduClass @@ -28,23 +28,24 @@ Do not use ## EXAMPLES -### Example 1 +### Example 1 ``` Do not use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -54,13 +55,15 @@ Accept wildcard characters: False ``` ### -Building + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -ClassId + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -ClassName + +> Applicable: SharePoint Server 2013 + {Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -DayOfWeek + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -134,13 +145,15 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -150,13 +163,15 @@ Accept wildcard characters: False ``` ### -Room + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -166,13 +181,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -182,13 +199,15 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -198,13 +217,15 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -214,13 +235,15 @@ Accept wildcard characters: False ``` ### -Year + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAdminComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAdminComponent.md index 856562a90..29814772e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAdminComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAdminComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchAdminComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchAdminComponent @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -45,13 +45,14 @@ This example adds a new Search Administration Component to the inactive topology ### -SearchServiceInstance +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance that will host the new admin component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new admin component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAnalyticsProcessingComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAnalyticsProcessingComponent.md index b857351ed..bf00176ea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAnalyticsProcessingComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchAnalyticsProcessingComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchAnalyticsProcessingComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchAnalyticsProcessingComponent @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -45,13 +45,14 @@ This example adds a new Search Analytics Processing Component to the inactive to ### -SearchServiceInstance +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance that will host the new analytics processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new analytics processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentEnrichmentConfiguration.md index d452544f9..840d57f63 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchContentEnrichmentConfiguration schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchContentEnrichmentConfiguration @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration ``` @@ -39,6 +39,9 @@ This example creates a new ContentEnrichmentConfiguration object. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentProcessingComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentProcessingComponent.md index fbc6848b4..a5018dad3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentProcessingComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchContentProcessingComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchContentProcessingComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchContentProcessingComponent @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -45,15 +45,15 @@ This example adds a new Search Content Processing Component to the inactive topo ### -SearchServiceInstance -Specifies the search service instance that will host the new content processing component. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the search service instance that will host the new content processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +63,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new content processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,13 +124,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlComponent.md index f4b01cd3c..efa3d69aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlComponent @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -45,15 +45,15 @@ This example adds a new Search Crawl Component to the inactive topology for the ### -SearchServiceInstance -Specifies the search service instance that will host the new crawl component. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the search service instance that will host the new crawl component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +63,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new crawl component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,13 +124,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlContentSource.md index 2b860733b..e972cd679 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlContentSource.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlContentSource schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlContentSource @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Type File -name FileServer -StartAddresses file://someserver/public @@ -45,6 +45,8 @@ This example creates a new content source of type file to crawl a file system. ### -AssignmentCollection +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,12 +56,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -70,16 +70,16 @@ Accept wildcard characters: False ### -BDCApplicationProxyGroup +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy to use for a business type content source. This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -90,16 +90,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,17 +110,17 @@ Accept wildcard characters: False ### -CrawlPriority +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the priority of this content source. The value must be one of the following integers: 1= Normal, 2=High. - ```yaml Type: CrawlPriority Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -131,15 +131,15 @@ Accept wildcard characters: False ### -CustomProtocol -Specifies the custom protocol, handled by the custom connector, to use for this content source. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the custom protocol, handled by the custom connector, to use for this content source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,15 +150,15 @@ Accept wildcard characters: False ### -LOBSystemSet -Specifies a comma-separated list of Business Data Connectivity metadata store system names and system instance names for a business type content source. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies a comma-separated list of Business Data Connectivity metadata store system names and system instance names for a business type content source. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,15 +169,15 @@ Accept wildcard characters: False ### -MaxPageEnumerationDepth -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,15 +188,15 @@ Accept wildcard characters: False ### -MaxSiteEnumerationDepth -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,17 +207,17 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the content source to create. The type must be a valid name of a ContentSource object (for example, ContentSource1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -228,17 +228,17 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search service application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -249,6 +249,8 @@ Accept wildcard characters: False ### -SharePointCrawlBehavior +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies crawl behavior for a SharePoint type content source. The behavior can be either: @@ -257,12 +259,10 @@ CrawlSites to crawl only particular site collections. CrawlVirtualServers to crawl the entire server and all site collections on the server. - ```yaml Type: SharePointCrawlBehavior Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,17 +273,17 @@ Accept wildcard characters: False ### -StartAddresses +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the comma-separated list of URLs at which to start a crawl for this content source. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -294,18 +294,18 @@ Accept wildcard characters: False ### -Tag +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL for the page to modify the settings for a custom content source. The string that specifies the URL can contain a maximum of 1,024 characters. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -316,7 +316,9 @@ Accept wildcard characters: False ### -Type -Specifies the name of the content source type. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the name of the content source type. The value Business is for the Business Data Connectivity metadata store. The value Exchange is for Microsoft Exchange public folders. The value Custom is for a custom content source type. @@ -324,12 +326,10 @@ The value Custom is for a custom content source type. The type must be the valid name of a content source type; for example, custom. - ```yaml Type: ContentSourceType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -340,16 +340,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlCustomConnector.md index 88d96b399..1cfaee69b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlCustomConnector.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlCustomConnector schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlCustomConnector @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -ModelFilePath \\models\myFileTypeModel.mft -Protocol "mftml://" @@ -43,13 +43,15 @@ This example creates a custom connector for a file type whose model is located a ## PARAMETERS ### -ModelFilePath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path to a model file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string version of the protocol; for example, dctm://. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that is associated with the protocol. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object @@ -82,8 +89,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the custom connector that appears on the SharePoint Central Administration Web site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlDatabase.md index ff9cc60ce..0933dee45 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlDatabase.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlDatabase @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlDatabase -SearchApplication $ssa -DatabaseName newCrawlDB @@ -43,6 +43,9 @@ This example creates a new crawl database named newCrawlDB for the mySearchServi ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. @@ -50,8 +53,7 @@ The type must be a valid name of a SQL Server database; for example, CrawlStoreD ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -68,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,13 +126,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the password for the Microsoft SQL Server database server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +144,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -141,8 +154,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +164,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name specified in the Database Server parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -168,13 +182,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Server that is used for failover when SQL Server mirroring is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +200,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -191,7 +210,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlExtension.md index 4bf5f24b6..0336f50bb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlExtension.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlExtension schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlExtension @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlExtension -Name "pdf" -SearchApplication $ssa @@ -43,13 +43,15 @@ This example adds the PDF file type to the list of file name extensions to inclu ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new file name extension. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the extension collection. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -66,8 +71,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlMapping.md index 0a64d93ef..86b3062a8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlMapping.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlMapping @@ -29,10 +29,9 @@ The New-SPEnterpriseSearchCrawlMapping cmdlet is run when the search functionali For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlMapping -SearchApplication $ssa -Url "file://location1" -Target "https://location2" @@ -43,6 +42,9 @@ This example will change the query results link from the file share where the it ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the source URI for the crawl mapping. The type must be a valid URL, in the form https://server_name. @@ -50,8 +52,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -68,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the target URI for the crawl mapping to get. The type must be a valid URI; for example, file:\\\\ server_name\sitedocs. @@ -87,7 +93,6 @@ The type must be a valid URI; for example, file:\\\\ server_name\sitedocs. Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +116,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlRule.md index c91f02368..54e239162 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchCrawlRule.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchCrawlRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchCrawlRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new crawl rule. - ## SYNTAX ``` @@ -27,16 +26,14 @@ New-SPEnterpriseSearchCrawlRule [-AccountName ] [-AccountPassword [-WhatIf] [] ``` - ## DESCRIPTION The `New-SPEnterpriseSearchCrawlRule` cmdlet creates special rules for crawling items that are contained in the specified path. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Path https://ExampleSharePointSite -CrawlAsHttp 1 -Type InclusionRule @@ -45,18 +42,18 @@ New-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Path https://ExampleSha This example creates an inclusion type crawl rule for the site at https://ExampleSharePointSite. The rule specifies that the site be crawled as an HTTP site. - ## PARAMETERS ### -AccountName -Specifies the account to use when applying the crawl rule. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the account to use when applying the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,14 +63,15 @@ Accept wildcard characters: False ``` ### -AccountPassword -Specifies the account to use when applying the crawl rule. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the account to use when applying the crawl rule. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,12 +92,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +105,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the following authentication types to access matching URLs: BasicAccountRuleAccess -- Specifies the account name and password that are required for this authentication type. @@ -120,12 +122,10 @@ CookieRuleAccess -- Specifies private parameters and a list of error pages that AnonymousAccess-- Specifies that the matching URLs have to be accessed anonymously. - ```yaml Type: CrawlRuleAuthenticationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,15 +135,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -153,14 +154,15 @@ Accept wildcard characters: False ``` ### -ContentClass -Specifies the string that is sent to the protocol handler for any content that matches the crawl rule. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the string that is sent to the protocol handler for any content that matches the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +172,15 @@ Accept wildcard characters: False ``` ### -CrawlAsHttp -Specifies whether the crawler should crawl content from a hierarchical content source as HTTP content. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the crawler should crawl content from a hierarchical content source as HTTP content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +190,15 @@ Accept wildcard characters: False ``` ### -FollowComplexUrls -Specifies whether the index engine should crawl content with URLs that contain a question mark (?). +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the index engine should crawl content with URLs that contain a question mark (?). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,16 +208,17 @@ Accept wildcard characters: False ``` ### -IsAdvancedRegularExpression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the rule has a full regular expression syntax. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -223,14 +228,15 @@ Accept wildcard characters: False ``` ### -Path -Specifies a unique path to which a crawl rule applies. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies a unique path to which a crawl rule applies. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -240,13 +246,15 @@ Accept wildcard characters: False ``` ### -PluggableSecurityTimmerId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill PluggableSecurityTimmerId Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -256,16 +264,17 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines where in the list of crawl rules this crawl rule should be applied. The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -275,16 +284,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Search application that is associated with the crawl rule to be modified. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -294,14 +304,15 @@ Accept wildcard characters: False ``` ### -SuppressIndexing -Specifies whether the crawler should exclude the content of items that this rule applies to from the content index. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the crawler should exclude the content of items that this rule applies to from the content index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -311,15 +322,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of crawl rule. A value of zero (0) includes the rule, a value of 1 excludes the rule. - ```yaml Type: CrawlRuleType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -329,15 +341,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchFileFormat.md index e0e1c4f7c..4fb7eccf4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchFileFormat.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchFileFormat schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchFileFormat @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new file format to the parsing system. - ## SYNTAX ``` @@ -35,10 +34,9 @@ The system will only consider the new file format after a restart of the content For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchFileFormat -SearchApplication $ssa -FormatId foo -FormatName FooApp -MimeType "text/foo" @@ -46,18 +44,18 @@ New-SPEnterpriseSearchFileFormat -SearchApplication $ssa -FormatId foo -FormatNa This example uses the `New-SPEnterpriseSearchFileFormat` cmdlet to add a new file format FooApp with the belonging file name extension foo to the parsing system in the search service application referenced by $ssa - ## PARAMETERS ### -FormatId -Specifies the file name extension of the format to add. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the file name extension of the format to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,16 +65,17 @@ Accept wildcard characters: False ``` ### -FormatName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the format to add. Usually this is the name of the application handling the format. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -86,14 +85,15 @@ Accept wildcard characters: False ``` ### -MimeType -Specifies the mime type of the format to add. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the mime type of the format to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 3 @@ -103,14 +103,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application for which to add the new file format. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -120,6 +122,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,8 +136,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -159,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -166,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchIndexComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchIndexComponent.md index 149304a2a..0fc9ebad1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchIndexComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchIndexComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchIndexComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchIndexComponent @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new index component for the given topology and search service instance. - ## SYNTAX ``` @@ -29,10 +28,9 @@ New-SPEnterpriseSearchIndexComponent -SearchServiceInstance Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service instance that will host the new index component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +61,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new index component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,13 +122,15 @@ Accept wildcard characters: False ``` ### -IndexPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the index partition number to assign to the new search index component. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,19 +140,20 @@ Accept wildcard characters: False ``` ### -RootDirectory + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the root directory that will hold the index location for the new search index component. This is needed if you want to isolate the index on dedicated discs in order to avoid I/O contention with other parts of the system, other system sharing the same disks, or because you do not want to risk the index filling up the OS disk (generally C: ) If you specify the root directory to be the root of a volume, e.g. -E:, the index will not be cleaned up if you delete the SSA. +E:, the index will not be cleaned up if you delete the SSA. You will then have to delete the SSA manually. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +163,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +181,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +191,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLanguageResourcePhrase.md index aa03cd95f..c48e11cc5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLanguageResourcePhrase.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchLanguageResourcePhrase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchLanguageResourcePhrase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a language resource phrase to a shared search application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The `New-SPEnterpriseSearchLanguageResourcePhrase` cmdlet adds a query keyword p For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language en-us -Type QuerySuggestionBlockList -Name secret @@ -41,10 +39,12 @@ New-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language e This example adds a new entry to the QuerySuggestionBlockList for the en-us language. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +53,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -68,15 +66,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -86,16 +85,17 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the phrase for the specified source language. The type must be a valid name of a language; for example, en-us or ja-jp. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,17 +105,18 @@ Accept wildcard characters: False ``` ### -Mapping + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,16 +126,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the term to add to the list specified in the Type parameter. The type must be a valid name of a language resource phrase (for example, LanguageResourcePhrase1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -144,6 +146,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -153,12 +158,10 @@ The owner must be one of the following valid levels: - Site Collection - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -168,16 +171,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -187,14 +191,15 @@ Accept wildcard characters: False ``` ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +209,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of the new phrase. The type must be one of the following valid types of phrases: @@ -213,12 +221,10 @@ The type must be one of the following valid types of phrases: - Nickname - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -228,15 +234,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLinksDatabase.md index e5d853d26..54e0c0981 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchLinksDatabase.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchLinksDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchLinksDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new links database for a search service application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchLinksDatabase -DatabaseName LinksDB_1 -SearchApplication $ssa @@ -42,18 +40,19 @@ New-SPEnterpriseSearchLinksDatabase -DatabaseName LinksDB_1 -SearchApplication $ This example adds a new links database LinksDB_1 to the search service application. - ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the links database to obtain. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,14 +62,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the account to connect to the database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server to use for the host SQL database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the account to connect to the database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server to use for failover in the case of SQL Server mirroring. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +196,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -190,7 +206,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCategory.md index 3886bbd95..c875accec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCategory.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchMetadataCategory schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchMetadataCategory @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a crawled property category to a search service application. - ## SYNTAX ``` @@ -31,13 +30,12 @@ SPEnterpriseSearchMetadataCategory represents a category in the enterprise searc For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -$ssa = Get-SPEnterpriseSearchServiceApplication -$guid = [System.Guid]::NewGuid() +$ssa = Get-SPEnterpriseSearchServiceApplication +$guid = [System.Guid]::NewGuid() New-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Name MyCategory -DiscoverNewProperties $true -PropSet $guid ``` @@ -48,6 +46,9 @@ Therefore, new crawled properties will be added to the MyCategory metadata categ ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,12 +57,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,14 +70,15 @@ Accept wildcard characters: False ``` ### -AutoCreateNewManagedProperties -Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. ```yaml Type: Boolean Parameter Sets: (All) Aliases: auto -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -88,15 +88,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -106,14 +107,15 @@ Accept wildcard characters: False ``` ### -DiscoverNewProperties -Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. ```yaml Type: Boolean Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,14 +125,15 @@ Accept wildcard characters: False ``` ### -MapToContents -Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. ```yaml Type: Boolean Parameter Sets: (All) Aliases: m -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -140,16 +143,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the new metadata category. The type must be a valid name of a metadata category, for example, MetadataCategory1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -159,6 +163,9 @@ Accept wildcard characters: False ``` ### -PropSet + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Creates a new metadata category with the specified property set. Note that the specified property set is the identifier of the category. @@ -166,12 +173,10 @@ Therefore, two categories cannot share a property set. The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -181,16 +186,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the enterprise search metadata categories. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -200,15 +206,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCrawledProperty.md index 5cb8e407b..2e64361e4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataCrawledProperty.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchMetadataCrawledProperty schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchMetadataCrawledProperty @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a crawled property. - ## SYNTAX ``` @@ -32,10 +31,9 @@ Or, crawled properties are automatically created during regular crawls (see SPEn For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People @@ -46,10 +44,12 @@ New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name "MyC This example maps the new crawled property MyCrawlProp to the People metadata category for the default search service application. The mapping uses the constraints from the existing People category. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -58,12 +58,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,16 +71,17 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to which metadata category the crawled property should be added The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - ```yaml Type: CategoryPipeBind Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -92,15 +91,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,15 +110,16 @@ Accept wildcard characters: False ``` ### -IsMappedToContents + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled property should be mapped to managed properties. Specify true to map a crawled property to a managed property. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,15 +129,16 @@ Accept wildcard characters: False ``` ### -IsNameEnum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the crawled property name is of type integer. Specified by true or false. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: ie -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -146,16 +148,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the new crawled property. The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -165,16 +168,17 @@ Accept wildcard characters: False ``` ### -PropSet + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the property set that belongs to an existing category. A valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -184,16 +188,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawled property. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -203,16 +208,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -222,16 +228,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -241,19 +248,21 @@ Accept wildcard characters: False ``` ### -VariantType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the crawled property as the specified variant type. For more information about valid values for this property, see VARIANT Type Constants (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409) (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409). The type must be an integer that specifies the variant data type of the property set. -> [!NOTE] +> [!NOTE] > This parameter is required although the value is not used in SharePoint Server 2013 through SharePoint Server 2019. You will see an Obsolete warning when running the cmdlet. You may ignore this message. ```yaml Type: Int32 Parameter Sets: (All) Aliases: vt -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -263,15 +272,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataManagedProperty.md index ea924edb7..b5bb61d4b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataManagedProperty.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchMetadataManagedProperty schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchMetadataManagedProperty @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a managed property to a shared search application. - ## SYNTAX ``` @@ -34,10 +33,9 @@ SPEnterpriseSearchMetadataManagedProperty represents a managed property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchMetadataManagedProperty -Name AboutMeUpdate -SearchApplication $ssa -Type 4 @@ -45,10 +43,12 @@ New-SPEnterpriseSearchMetadataManagedProperty -Name AboutMeUpdate -SearchApplica This example creates a new managed property named AboutMeUpdate in the default search service application and sets it type to DateTime. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,12 +57,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,15 +70,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -90,14 +89,15 @@ Accept wildcard characters: False ``` ### -DefaultForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: def -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -107,16 +107,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a description to the metadata managed property. The type must be a valid string. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -126,6 +127,9 @@ Accept wildcard characters: False ``` ### -EnabledForQueryIndependentRank + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. The type must be one of the following query-independent ranking features in the custom model XML: @@ -134,12 +138,10 @@ The type must be one of the following query-independent ranking features in the - categoryFeature - languageFeature - ```yaml Type: Boolean Parameter Sets: (All) Aliases: qir -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -149,14 +151,15 @@ Accept wildcard characters: False ``` ### -EnabledForScoping -Specifies that the managed property can be used in a scope definition. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the managed property can be used in a scope definition. ```yaml Type: Boolean Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,14 +169,15 @@ Accept wildcard characters: False ``` ### -FullTextQueriable -Specifies that the managed property can be used in enterprise search SQL queries. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the managed property can be used in enterprise search SQL queries. ```yaml Type: Boolean Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -183,13 +187,15 @@ Accept wildcard characters: False ``` ### -IncludeInAlertSignature + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether this managed property should be included in the alert signature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: ia -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -199,14 +205,15 @@ Accept wildcard characters: False ``` ### -IncludeInMd5 -Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: im5 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -216,16 +223,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new managed property. The type must be a valid name of a managed property, for example, ManagedProperty1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -235,15 +243,16 @@ Accept wildcard characters: False ``` ### -NameNormalized + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. If value is set to true, the values are normalized. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nn -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -253,14 +262,15 @@ Accept wildcard characters: False ``` ### -NoWordBreaker -Specifies that the values for this managed property are processed by a word breaker. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the values for this managed property are processed by a word breaker. ```yaml Type: Boolean Parameter Sets: (All) Aliases: nw -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -270,14 +280,15 @@ Accept wildcard characters: False ``` ### -Queryable -Specifies whether this managed property is queryable or not. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether this managed property is queryable or not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: q -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -287,14 +298,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that duplicate values for the managed property are removed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rd -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -304,15 +316,16 @@ Accept wildcard characters: False ``` ### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. -Otherwise, all mapped crawled properties that have a value are copied. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. +Otherwise, all mapped crawled properties that have a value are copied. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -322,14 +335,15 @@ Accept wildcard characters: False ``` ### -Retrievable -Specifies whether this managed property is retrievable or not. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether this managed property is retrievable or not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -339,13 +353,15 @@ Accept wildcard characters: False ``` ### -SafeForAnonymous + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether it is acceptable to display the contents of the property in search results for anonymous searches. ```yaml Type: Boolean Parameter Sets: (All) Aliases: sfa -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -355,16 +371,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the managed property collection. The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -374,16 +391,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -393,16 +411,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -412,6 +431,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the data type of the new managed property. The type must be one of the following data types: @@ -430,12 +452,10 @@ The type must be one of the following data types: 7 = Double - ```yaml Type: Int32 Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -445,14 +465,15 @@ Accept wildcard characters: False ``` ### -UserFlags -Reserved for future use. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Reserved for future use. ```yaml Type: Int16 Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -462,15 +483,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataMapping.md index 2b2756db7..c1fc92507 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchMetadataMapping.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchMetadataMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchMetadataMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a managed property mapping. - ## SYNTAX ``` @@ -31,10 +30,9 @@ SPEnterpriseSearchMetadataMapping represents a snapshot of a mapping between a m For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -51,6 +49,9 @@ The VarientType parameter is marked as obsolete but is still required when execu ## PARAMETERS ### -CrawledProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawled property to map. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -58,8 +59,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -69,6 +69,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to which the crawled property should be mapped. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -76,8 +79,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the metadata mapping. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -94,8 +99,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -116,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -144,6 +152,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mapping returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -151,8 +162,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +172,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mapping returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -169,8 +182,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +192,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +202,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryAuthority.md index af41cdf83..fd3729717 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an authoritative page to a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryAuthority -SearchApplication $ssa -Url https://contoso.com -Level 1.5 @@ -38,10 +36,12 @@ New-SPEnterpriseSearchQueryAuthority -SearchApplication $ssa -Url https://contos This example designates the URL https://contoso.com as an authoritative page with a relative importance of 1.5. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query authority page to create. The type must be a valid URL, in the form https://server_name. @@ -49,8 +49,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the level of the new authoritative page. Authoritative pagesare expert pages that link to the most relevant information. A search service application can have multiple authoritative pages. @@ -70,7 +72,6 @@ This parameter may receive a floating point value of 0.0 - 2.0, where 0.0 has th Type: Single Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the authority page collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -103,8 +109,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -125,8 +133,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -160,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryDemoted.md index 9c660408e..d80c72d19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryDemoted.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchQueryDemoted schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchQueryDemoted @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a demoted site rule to a shared search application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Query demoted sites are de-emphasized in relevance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryDemoted -Url https://examplesite -SearchApplication $ssa @@ -41,10 +39,12 @@ New-SPEnterpriseSearchQueryDemoted -Url https://examplesite -SearchApplication $ This example adds a demoted site rule for the URL https://examplesite.com to a search service application. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the new demoted site rule. The type must be a valid URL, in the form https://server_name. @@ -52,8 +52,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,13 +62,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the demoted site rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -86,8 +90,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryKeyword.md index 851ef44c0..3226b26d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryKeyword.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchQueryKeyword schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchQueryKeyword @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a keyword term to a shared search application. - ## SYNTAX ``` @@ -34,20 +33,21 @@ You cannot use this cmdlet after a site collection is upgraded to SharePoint Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPEnterpriseSearchQueryKeyword -Term Tangible -Site https://myserver/sites/team ``` This example creates a new query keyword for the site https://myserver/sites/team with the term Tangible. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,12 +56,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,15 +69,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -89,16 +88,17 @@ Accept wildcard characters: False ``` ### -Contact + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name associated with the new keyword. The type must be a valid user name; for example, KeywordUser1. - ```yaml Type: String Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,16 +108,17 @@ Accept wildcard characters: False ``` ### -Definition + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the definition of the new keyword term. The type must be a valid string; for example, a keyword term definition. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,17 +128,18 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -147,17 +149,18 @@ Accept wildcard characters: False ``` ### -ReviewDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the review date of the keyword term. The default value is MaxDate. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -167,16 +170,17 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the new keyword term to the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. - ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -186,17 +190,18 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the activation date for the keyword term. The default value is the current date. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -206,16 +211,17 @@ Accept wildcard characters: False ``` ### -Term + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the keyword term to create. The type must be a valid string that contains a keyword term (for example, KeywordTerm1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -225,15 +231,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryProcessingComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryProcessingComponent.md index cc8d9e053..1682a0b68 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryProcessingComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryProcessingComponent.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchQueryProcessingComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchQueryProcessingComponent @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new query processing component for the given topology and search service instance. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The change is effectuated when the search topology is enabled. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -45,14 +43,15 @@ This example adds a new Search Query Processing Component to the inactive topolo ## PARAMETERS ### -SearchServiceInstance -Specifies the search service instance that will host the new query processing component. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service instance that will host the new query processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology where the new query processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScope.md index 28f7a85bf..4e4f70f6a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScope.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchQueryScope schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchQueryScope @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a query results scope to a shared search application. - ## SYNTAX ``` @@ -38,10 +37,9 @@ SPEnterpriseSearchQueryScope represents a query results scope used by all shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must crawl" -DisplayInAdminUI $true -SearchApplication $ssa @@ -49,20 +47,20 @@ New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must cra This example adds a scope named MustCrawl that will be displayed in the administration UI to the search service application named MySSA. - ## PARAMETERS ### -AlternateResultsPage + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location to display results for the new query scope. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: a -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -72,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,12 +81,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,17 +94,18 @@ Accept wildcard characters: False ``` ### -CompilationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the compilation type of the new scope. The value 0 specifies the conditionally compiled scope type and the value 1 specifies the always compiled scope type. The type must be either of the following: 0 or 1. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,15 +115,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -133,16 +134,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a description of the new query scope. The type must be a valid string; for example, a description of a query scope. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -152,15 +154,16 @@ Accept wildcard characters: False ``` ### -DisplayInAdminUI + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new scope is displayed in the administration application user interface (UI). The default setting is to hide the new scope in the administration application UI. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: disp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -170,13 +173,15 @@ Accept wildcard characters: False ``` ### -ExtendedSearchFilter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill ExtendedSearchFilter Description}} ```yaml Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -186,16 +191,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the scope to create. The type must be a valid name of a scope (for example, Scope1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -205,16 +211,17 @@ Accept wildcard characters: False ``` ### -OwningSiteUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint site that is associated with the new scope. The type must be a valid SharePoint site URL, in the form https://server_name. - ```yaml Type: Uri Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -224,16 +231,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -243,15 +251,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScopeRule.md index 2c3063cb5..33c702e63 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchQueryScopeRule.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchQueryScopeRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchQueryScopeRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a shared scope rule to a query scope. - ## SYNTAX ``` @@ -39,10 +38,9 @@ SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication C:\PS>$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -51,10 +49,12 @@ New-SPEnterpriseSearchQueryScopeRule -Scope $scope -RuleType AllContent -Url htt This example creates a new scope rule of type AllContent for the URL https://criticalSite. - ## PARAMETERS ### -RuleType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of scope rule to create. The type must be one of the following values: AllContent, Url, or PropertyQuery. @@ -63,7 +63,6 @@ The type must be one of the following values: AllContent, Url, or PropertyQuery. Type: String Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Applies the query scope rule to the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -81,7 +83,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the results URL that is associated with the query scope rule. The type must be a valid URL, in the form https://server_name. @@ -99,7 +103,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +126,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -FilterBehavior + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of scope rule to create for the query scope. The default value is Include. @@ -157,7 +167,6 @@ The type must be one of the following values: Exclude, Include, or Require. Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to use for the PropertyQuery scope rule. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a managed property (for example, ManagedProperty1); or an instance of a valid ManagedProperty object. @@ -175,7 +187,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ManagedPropertyPipeBind Parameter Sets: (All) Aliases: mname -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -185,13 +196,15 @@ Accept wildcard characters: False ``` ### -MatchingString + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: text -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -201,13 +214,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the property value to use when matching the PropertyQuery rule type. ```yaml Type: String Parameter Sets: (All) Aliases: value -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -217,6 +232,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -224,8 +242,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,13 +252,15 @@ Accept wildcard characters: False ``` ### -UrlScopeRuleType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: ut -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -251,6 +270,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -258,7 +280,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchRankingModel.md index 52b48b1fd..deea85df4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchRankingModel.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchRankingModel schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchRankingModel @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a ranking model to a shared search application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The name, description and identifier (ID) for the new ranking model are containe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SPWeb -SPWeb https://sharepoint/team @@ -43,10 +41,12 @@ New-SPEnterpriseSearchRankingModel -SearchApplication $ssa -Owner $owner -Rankin This example creates a ranking model for the site https://sharepoint/team for the search service application Search Service Application from the file rankModel.xml which is stored in the current directory. - ## PARAMETERS ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -55,7 +55,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -RankingModelXML + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the XML representation of the new ranking model. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the ranking model. The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -88,8 +92,7 @@ The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a val ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultItemType.md index cf7ffd07c..ca9443041 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultItemType.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new result item type. - ## SYNTAX ### New @@ -52,10 +51,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith" $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -84,13 +82,15 @@ Finally, the example defines the rule item type by its name, the rule collection ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the result item type. ```yaml Type: String -Parameter Sets: New +Parameter Sets: New, Copy Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 2 @@ -99,27 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Copy -Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -Rules -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -Rules Specifies the collection of rules to evaluate the result properties against. ```yaml Type: PropertyRuleCollection -Parameter Sets: New +Parameter Sets: New, Copy Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 3 @@ -128,27 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PropertyRuleCollection -Parameter Sets: Copy -Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -RulePriority -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -RulePriority Specifies which priority the collection of rules has compared to other rules. ```yaml Type: Int32 Parameter Sets: (All) Aliases: priority -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 4 @@ -158,13 +136,15 @@ Accept wildcard characters: False ``` ### -DisplayProperties + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which result properties to display. ```yaml Type: String Parameter Sets: (All) Aliases: dp -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 5 @@ -174,6 +154,9 @@ Accept wildcard characters: False ``` ### -SourceID + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Identifies the search result source that the result item type applies to. Leave this parameter blank to apply to all result sources. @@ -181,7 +164,6 @@ Leave this parameter blank to apply to all result sources. Type: Guid Parameter Sets: (All) Aliases: sid -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 6 @@ -191,14 +173,16 @@ Accept wildcard characters: False ``` ### -DisplayTemplateUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the display template that shall be used for rendering the results. Specify an absolute URL. ```yaml Type: String -Parameter Sets: New +Parameter Sets: New, Copy Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 7 @@ -207,27 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Copy -Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -ExistingResultItemType -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -ExistingResultItemType Specifies an existing result item type to which new rules or displayed properties can be added. ```yaml Type: ResultItemTypePipeBind Parameter Sets: Copy Aliases: copy -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -237,13 +210,15 @@ Accept wildcard characters: False ``` ### -ExistingResultItemTypeOwner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which an existing result item type was created. ```yaml Type: SearchObjectOwner Parameter Sets: Copy Aliases: eo -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -253,13 +228,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -269,6 +246,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -280,8 +260,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -291,6 +270,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -298,7 +280,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -308,6 +289,9 @@ Accept wildcard characters: False ``` ### -OptimizeForFrequentUse + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enable this flag if you always want the properties of this result item type to be requested, regardless of whether the result type is triggered. This will improve performance as long as it is only enabled on the most frequently used result item types. @@ -315,7 +299,6 @@ This will improve performance as long as it is only enabled on the most frequent Type: Boolean Parameter Sets: (All) Aliases: opt -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -325,14 +308,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,14 +327,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -359,6 +346,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -366,7 +356,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultSource.md index 378d3c463..5f996ff03 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchResultSource.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchResultSource schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchResultSource @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new result source. - ## SYNTAX ``` @@ -34,10 +33,9 @@ Result Sources replace Search Scopes, which are now deprecated. This cmdlet supports the same create operations as are supported through the "Manage Result Sources" page in Central Administration, except the operations "Form Authentication" and "Cookie Authentication". For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -46,24 +44,24 @@ New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Provid This example creates a new search service application level result source, named "Custom SharePoint Result Source". - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - + When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,6 +71,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication type of the new result source. A specific set of authentication types are supported for each search provider type and, if parameter is not specified, the authentication type will default based on search provider type. @@ -83,16 +84,14 @@ When using a Local SharePoint Search/Local SharePoint People Search provider, th When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. +When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. All authentication types are listed in the enum FederationAuthType. - ```yaml Type: FederationAuthType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,19 +101,20 @@ Accept wildcard characters: False ``` ### -AutoDiscover + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to use automatic discovery of the Exchange server endpoint for the new result source. -Setting value to true ($true) states that automatic discovery should be used. +Setting value to true ($true) states that automatic discovery should be used. If not specified or set to false ($false), automatic discovery will not be used. Only applicable when using an Exchange search provider. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,15 +124,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -142,14 +143,15 @@ Accept wildcard characters: False ``` ### -Description -Specifies the description of the new result source. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the description of the new result source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,17 +161,18 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the new result source should be set as default or not, for the scope specified by the Owner parameter. Setting value to true ($true) states that the result source should be set as default. If not specified or set to false, the new result source will not be set as default. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,18 +182,19 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new result source. Names must be unique at each administrative level. For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -200,14 +204,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is created. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search object owner that defines the scope at which the corresponding result source is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -217,16 +222,17 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the user credentials to use to connect to the new result source. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -236,16 +242,17 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search provider to be used by the new result source. Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -255,6 +262,9 @@ Accept wildcard characters: False ``` ### -QueryTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query transformation template of the new result source. Incoming queries are changed according to the template, to use this new query text instead. @@ -265,12 +275,10 @@ For example, to only return OneNote items, set the new text to "{searchTerms} fi Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". Default value is {searchTerms}. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -280,11 +288,14 @@ Accept wildcard characters: False ``` ### -RemoteUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection URL template of the new result source. Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1 and Exchange (if AutoDiscover is not turned on). -When using other search providers the parameter is ignored. +When using other search providers the parameter is ignored. For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. @@ -293,12 +304,10 @@ For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. For Exchange, specify the Exchange EWS URL from which to retrieve results. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -308,16 +317,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -327,18 +337,19 @@ Accept wildcard characters: False ``` ### -SsoId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the reverse proxy certificate Secure Store Id to use to connect to the new result source. Must be specified if authentication type (AuthenticationType) is set to FederationAuthType.SSO (Single Sign On). If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -348,16 +359,17 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name of the user credentials to use to connect to the new result source. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -367,15 +379,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSecurityTrimmer.md index 5b3d44391..cb4e54ea6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSecurityTrimmer.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchSecurityTrimmer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchSecurityTrimmer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a custom security trimmer to a shared search application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ SPEnterpriseSearchSecurityTrimmer represents a security trimmer that performs cu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -TypeName "SearchCustomSecurityTrimmer.CustomSecurityTrimmerPost, SearchCustomSecurityTrimmer, Version=1.0.0.0, Culture=neutral, PublicKeyToken=48e046c834625a88, processorArchitecture=MSIL" -Id 1 @@ -42,10 +40,12 @@ New-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -TypeName "SearchC This example adds a new custom security trimmer for trimming the returned result set. This new security trimmer is added to the search application by using the id 1. The strong named assembly contains the class CustomSecurityTrimmerPost, which implements the ISecurityTrimmerPost interface. - ## PARAMETERS ### -Id + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the security trimmer to use for the specified search application. If this parameter specifies an existing custom security trimmer, the trimmer will be removed and replaced with the custom trimmer. @@ -55,8 +55,7 @@ Remove the existing trimmer before you add a new one. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -RulePath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content path where the security trimmer will be applied. The string must be a valid URI in the form file:\\\\server_name\content, and it must correspond to an existing crawl rule. @@ -73,8 +75,7 @@ The string must be a valid URI in the form file:\\\\server_name\content, and it ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the security trimmer to the specified search application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -91,8 +95,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -TypeName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the strong named assembly name of a security trimmer type. The strong name must refer to a type whose assembly is deployed to the global assembly cache on a query server and that type must implement the ISecurityTrimmerPre, ISecurityTrimmerPost or ISecurityTrimmer2 interface. Security trimming can be done in two places: before query execution (ISecurityTrimmerPre) or after the results set has returned (ISecurityTrimmerPost or ISecurityTrimmer2). @@ -110,8 +116,7 @@ For how to reference a strong name assembly, see https://msdn.microsoft.com/en-u ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -128,8 +136,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name-value pairs that specify the configuration properties. The type must be in the following name/value pair format: Name1~Value1~Name2~Value2~ @@ -163,8 +175,7 @@ The type must be in the following name/value pair format: Name1~Value1~Name2~Val ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +185,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -181,7 +195,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplication.md index 2fd671c48..bd209d1ff 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a search service application to a farm. - ## SYNTAX ``` @@ -34,10 +33,9 @@ A farm can include multiple search service applications. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $appPool = New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account 'CONTOSO\ServiceApps' New-SPEnterpriseSearchServiceApplication -Name "Search Service Application" -ApplicationPool $appPool @@ -47,9 +45,9 @@ This example creates a new search service application named NewSSA in a new appl A search service application that is created in this manner will have active search topology, but no search components. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` -$appPool = New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account 'CONTOSO\ServiceApps' +$appPool = New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account 'CONTOSO\ServiceApps' New-SPEnterpriseSearchServiceApplication -Name "Search Service Application" -ApplicationPool $appPool -DatabaseName SearchServiceAppDB ``` @@ -60,6 +58,9 @@ A search service application that is created in this manner will have active sea ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the names of the new search application. The type must be a valid name of a search application, for example, SearchApp1. @@ -67,8 +68,7 @@ The type must be a valid name of a search application, for example, SearchApp1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -78,6 +78,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS application pool to use for the new search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL of a search application, in the form https://server_name; or an instance of a valid SPIisWebServiceApplicationPool object. @@ -85,8 +88,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +112,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -135,6 +141,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the new search application. The type must be a valid name of a SQL Server database, for example, SearchAppDB1. @@ -142,8 +151,7 @@ The type must be a valid name of a SQL Server database, for example, SearchAppDB ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +161,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user ID that is used for accessing the search application database on SQL Server. The type must be a valid password. @@ -160,8 +171,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +181,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. @@ -178,8 +191,7 @@ The type must be a valid SQL Server host name, for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +201,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user ID to use for accessing the search application SQL Server database. The type must be a valid user name, for example, SearchUserName1. @@ -196,8 +211,7 @@ The type must be a valid user name, for example, SearchUserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,17 +221,18 @@ Accept wildcard characters: False ``` ### -Partitioned + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the search service application uses web-hosted mode. Web-hosted mode segregates results for a given hosted subscription. This property has no effect on SharePoint Server 2019. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,6 +242,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -234,7 +252,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -244,13 +261,15 @@ Accept wildcard characters: False ``` ### -AdminApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application pool to be used with the SearchAdminWebServiceApplication that is associated with SearchServiceApplication. If not specified, ApplicationPool will be used. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -CloudIndex + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When CloudIndex is true, this becomes a cloud Search service application that crawls on premises content in a cloud hybrid search solution. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +297,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SQL server that hosts the mirror instances of search databases. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplicationProxy.md index f3727e51e..1f768dc81 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new search application proxy to a farm. - ## SYNTAX ### SSA @@ -46,10 +45,9 @@ For more information about how to use parameter sets, see Cmdlet Parameter Sets For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchServiceApplicationProxy -Name 'Search Service Application Proxy' -SearchApplication $ssa @@ -57,10 +55,12 @@ New-SPEnterpriseSearchServiceApplicationProxy -Name 'Search Service Application This example adds a search service application proxy to a search service application. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the search application proxy to create. The type must be a valid string, for example, SearchAppProxy1. @@ -68,8 +68,7 @@ The type must be a valid string, for example, SearchAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -79,6 +78,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI to the search application to use for search. The type must be a valid URI, in the form file:\\\\server_name\searchapp. @@ -86,8 +88,7 @@ The type must be a valid URI, in the form file:\\\\server_name\searchapp. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: SSA -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +98,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI to the search application to use for search. The type must be a valid URI, in the form file:\\\\server_name\searchapp. @@ -104,8 +108,7 @@ The type must be a valid URI, in the form file:\\\\server_name\searchapp. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -126,8 +132,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -MergeWithDefaultPartition + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Merges the index partition for the proxy with the default index partition collection for the search service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +179,16 @@ Accept wildcard characters: False ``` ### -Partitioned + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the search service application must use web-hosted mode. web-hosted mode segregates results for a given hosted subscription. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +198,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -194,7 +208,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSiteHitRule.md index 1d7df574f..8dc5442d8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchSiteHitRule.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchSiteHitRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchSiteHitRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new site hit rule for a search application. - ## SYNTAX ``` @@ -30,27 +29,27 @@ The new site hit rule is used by all search service applications on the current For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE------------------ +### EXAMPLE ``` New-SPEnterpriseSearchSiteHitRule -Name myHost -Behavior 0 -HitRate 40 ``` This example creates a new site hit rule on the myHost host that limits to 40 the number of simultaneous requests. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the host to which the site hit rule should be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -Behavior + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines a rule to be followed when the farm's search service crawls the given site. If a value of zero is specified, the hit rate is the maximum number of simultaneous requests. If a value of 1 is specified, then hit rate is the number of seconds to delay between requests to the server. @@ -67,8 +69,7 @@ If a value of zero is specified, the hit rate is the maximum number of simultane ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -HitRate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Value to use for maximum requests or seconds of delay, according to behavior. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -101,8 +107,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service in the farm that hosts the crawl. The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet will be used. @@ -136,8 +146,7 @@ The type must be an instance of a valid SearchService object; otherwise, the loc ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -154,7 +166,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchTopology.md index d5f523f11..ac566ff74 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPEnterpriseSearchTopology.md @@ -7,7 +7,7 @@ title: New-SPEnterpriseSearchTopology schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPEnterpriseSearchTopology @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new search topology in the given search service application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Otherwise, an empty topology is created. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -42,8 +40,7 @@ New-SPEnterpriseSearchTopology -SearchApplication $ssa This example creates a new, empty search topology in the search service application referenced by $ssa. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -52,10 +49,12 @@ New-SPEnterpriseSearchTopology -SearchApplication $ssa -Clone -SearchTopology $t This example creates a new search topology in the search service application referenced by $ssa by cloning the existing topology referenced by $topology. - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which the search topology will belong. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -63,8 +62,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,14 +72,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +91,15 @@ Accept wildcard characters: False ``` ### -Clone + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new search topology is to be created by cloning an existing search topology. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +109,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new search topology is to be created by cloning an existing search topology. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,13 +127,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing search topology of which the new topology will be a clone. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBIServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBIServer.md index eb0951e6f..55e5e9c80 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBIServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBIServer.md @@ -7,19 +7,17 @@ title: New-SPExcelBIServer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelBIServer ## SYNOPSIS - Configures Analysis Services servers to work with Excel Services. - ## SYNTAX ``` @@ -27,36 +25,34 @@ New-SPExcelBIServer [-AssignmentCollection ] [-Confirm] -ExcelServiceApplication -ServerId [-WhatIf] [] ``` - ## DESCRIPTION Use the New-SPExcelBIServer cmldet to configure Analysis Services servers to work with Excel Services. - - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPExcelBIServer -ExcelServiceApplication "MyExcel" -ServerID "MSS01" ``` This example configures the analysis server to work the Excel Service application named MyExcel and ServerID of MSS01. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -66,13 +62,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -82,13 +80,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the description of the Analysis server ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -98,13 +98,15 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -115,13 +117,14 @@ Accept wildcard characters: False ### -ServerId +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + The name of the Analysis Services server ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -138,7 +144,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBlockedFileType.md index 1235a2b20..0773f2ab3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBlockedFileType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelBlockedFileType.md @@ -7,7 +7,7 @@ title: New-SPExcelBlockedFileType schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelBlockedFileType @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a file type to the list of file types that Excel Services Application prevents from loading. - ## SYNTAX ``` @@ -30,21 +29,22 @@ The specified file type is prevented from loading by all instances of Excel Serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -C:\PS>$sa = Get-SPExcelServiceApplication +C:\PS>$sa = Get-SPExcelServiceApplication New-SPExcelBlockedFileType -FileType XLSM -ExcelServiceApplication $sa ``` This example adds an entry for XLSM to the list of file types that Excel Services Application currently prevents from loading. - ## PARAMETERS ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -52,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -FileType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the file types that are blocked from loading. The type must be one of the following file extensions: XLSX, XLSB, or XLSM. @@ -70,8 +72,7 @@ The type must be one of the following file extensions: XLSX, XLSB, or XLSM. ```yaml Type: FileType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +96,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataConnectionLibrary.md index 9440fa4c4..6977efe45 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataConnectionLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataConnectionLibrary.md @@ -7,7 +7,7 @@ title: New-SPExcelDataConnectionLibrary schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelDataConnectionLibrary @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new data connection library to Excel Services Application. - ## SYNTAX ``` @@ -25,7 +24,7 @@ New-SPExcelDataConnectionLibrary -Address -ExcelServiceApplication Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the address of the data connection library. The address must be unique in the list of trusted data connection libraries. @@ -58,8 +58,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -76,8 +78,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +102,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the data connection library. The type must be a valid string; for example, this is a custom OLEDB provider. @@ -133,8 +141,7 @@ The type must be a valid string; for example, this is a custom OLEDB provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +161,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataProvider.md index aea84e9ce..805e0bae0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelDataProvider.md @@ -7,7 +7,7 @@ title: New-SPExcelDataProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelDataProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new safe data provider to Excel Services Application. - ## SYNTAX ``` @@ -26,34 +25,34 @@ New-SPExcelDataProvider -ExcelServiceApplication Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelDataProvider list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -61,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -72,6 +70,9 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the name of the provider. This ID should be present in the connection strings generated by this provider and the ID must be unique for the provider type. @@ -80,8 +81,7 @@ The type must be a valid name of a provider; for example CustomOLEDB. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -ProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the supported type of data provider to add to safe provider list. The type must be one of the following: OleDb, Odbc, or OdbcDsn. @@ -98,8 +101,7 @@ The type must be one of the following: OleDb, Odbc, or OdbcDsn. ```yaml Type: DataProviderType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +125,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +145,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -148,6 +154,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the new data provider. The type must be a valid string; for example, "This is a custom OLEDB provider". @@ -155,8 +164,7 @@ The type must be a valid string; for example, "This is a custom OLEDB provider". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +184,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelFileLocation.md index 88314e4d8..c75a4b9e6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelFileLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelFileLocation.md @@ -7,7 +7,7 @@ title: New-SPExcelFileLocation schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelFileLocation @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new trusted location to Excel Services Application. - ## SYNTAX ``` @@ -32,7 +31,7 @@ New-SPExcelFileLocation -Address -ExcelServiceApplication Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a Web folder, or file directory from which Excel Services Application can load workbooks. The type must be a valid URL, in the form https://myPortal/myTeam; or a valid UNC path in form, \\\\server_name\folder_name @@ -77,8 +76,7 @@ The type must be a valid URL, in the form https://myPortal/myTeam; or a valid UN ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -88,6 +86,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -95,8 +96,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -106,6 +106,9 @@ Accept wildcard characters: False ``` ### -AbortOnRefreshOnOpenFail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that the loading of a Excel Services Application file automatically fails if an automatic data refresh operation fails when the file is opened. The load is failed only if the following conditions are true: @@ -115,8 +118,7 @@ The load is failed only if the following conditions are true: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -126,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -137,8 +142,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -148,6 +152,9 @@ Accept wildcard characters: False ``` ### -AutomaticVolatileFunctionCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. Valid values include: @@ -163,8 +170,7 @@ The type must be the integers -1 or 0, or an integer value in the range of 1 to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -174,6 +180,9 @@ Accept wildcard characters: False ``` ### -ChartAndImageSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum size, in megabytes, of a chart or image that can be opened. The default value is 1. @@ -182,8 +191,7 @@ The type must be a valid integer greater than 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -193,6 +201,9 @@ Accept wildcard characters: False ``` ### -ConcurrentDataRequestsPerSessionMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of concurrent external data requests allowed in each session. If a session must issue more than this number of requests, additional requests must be queued. The scope of this setting is the logical server. @@ -203,8 +214,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -214,6 +224,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -221,7 +234,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -231,6 +243,9 @@ Accept wildcard characters: False ``` ### -DefaultWorkbookCalcMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the calculation mode of workbooks. Settings other than File override the workbook settings. The default setting is File. @@ -240,8 +255,7 @@ The type must be one of the following: File, Manual, Auto, or AutoDataTables. ```yaml Type: DefaultWorkbookCalcMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -251,6 +265,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the new file location. The type must be a valid string; for example, this is the file location of the monthly sales reports. @@ -258,8 +275,7 @@ The type must be a valid string; for example, this is the file location of the m ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -269,13 +285,15 @@ Accept wildcard characters: False ``` ### -DisplayGranularExtDataErrors + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays granular error messages for external data failures for files in this location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -285,6 +303,9 @@ Accept wildcard characters: False ``` ### -ExternalDataAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the type of external data access allowed for workbooks. None specifies that data refresh is disabled. Dcl specifies that data is refreshed only when it uses a connection file in a trusted data connection library. @@ -303,8 +324,7 @@ DclAndEmbedded ```yaml Type: AllowExternalData Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -314,14 +334,16 @@ Accept wildcard characters: False ``` ### -IncludeChildren + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Indicates that subordinate URLs, directories and libraries are trusted. For example, if the trusted file location is https://portal and IncludeChildren is true, https://portal/subSite is also trusted, as is any URL subordinate to the URL specified in Address. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -331,6 +353,9 @@ Accept wildcard characters: False ``` ### -LocationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the type of location. Location type indicates how Excel Services Application retrieves files from the location specified in Address. The default setting is the SharePoint type. @@ -341,8 +366,7 @@ The type must be one of the following: SharePoint, UNC, or HTTP. ```yaml Type: LocationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -352,6 +376,9 @@ Accept wildcard characters: False ``` ### -ManualExtDataCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that Excel Services Application waits before it re-issues a manual, or user-initiated, external data request. During this time period, the results from the previous external data request can be returned from an external data cache. The default value is 300. @@ -363,8 +390,7 @@ The valid values are any one of the following items: ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -374,6 +400,9 @@ Accept wildcard characters: False ``` ### -NewWorkbookSessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a session for a new, unsaved, workbook remains active on Excel Services Application with no user activity. Valid values include the following: @@ -389,8 +418,7 @@ The type must be -1, 0, or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -400,6 +428,9 @@ Accept wildcard characters: False ``` ### -PeriodicExtDataCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that Excel Services Application waits before it re-issues an on-open or periodic (that is, automatic) external data request. During this time period, the results from the previous external data request can be returned from an external data cache. A value of -1 specifies never to refresh after the first query. @@ -410,8 +441,7 @@ The type must be -1, 0, or integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -421,6 +451,9 @@ Accept wildcard characters: False ``` ### -RequestDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum duration, in seconds, for a single request in a session. After this time elapses, the request times out. The default value is 300. @@ -430,8 +463,7 @@ The type must be -1 (no limit) or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -441,14 +473,16 @@ Accept wildcard characters: False ``` ### -RESTExternalDataAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections. The RESTExternalDataAllowed parameter has no effect if ExternalDataAllowed parameter is set to None. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -458,6 +492,9 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a session remains active on Excel Services Application with no user activity. Valid values include the following: @@ -473,8 +510,7 @@ The type must be -1, 0, or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -484,6 +520,9 @@ Accept wildcard characters: False ``` ### -ShortSessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a user has to make the initial interaction with a spreadsheet. After this time has elapsed, if the user is not active, the session is closed. The value must always be less than SessionTimeout. @@ -495,8 +534,7 @@ The type must be -1 or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -506,6 +544,9 @@ Accept wildcard characters: False ``` ### -UdfsAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that user-defined functions can be called by workbooks that are loaded from the trusted file location that is specified in Address. The default value is False. @@ -513,8 +554,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -524,14 +564,16 @@ Accept wildcard characters: False ``` ### -WarnOnDataRefresh + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that a warning is displayed to the user on the first refresh of data for the workbook. The default value is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -541,6 +583,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -548,7 +593,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -558,6 +602,9 @@ Accept wildcard characters: False ``` ### -WorkbookSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum size, in megabytes, of a workbook that can be loaded. The default value is 10. @@ -566,8 +613,7 @@ The type must be an integer value in the range of 1 to 2000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -577,13 +623,15 @@ Accept wildcard characters: False ``` ### -ChartRenderDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + {{Fill ChartRenderDurationMax Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelServiceApplication.md index b2c9b0d28..98db797f6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPExcelServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new instance of Excel Services Application. - ## SYNTAX ### ExistingTargetApplicationParameterSet @@ -47,33 +46,33 @@ New-SPExcelServiceApplication -ApplicationPool Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the existing IIS application pool to run the Web service in for the new Excel Service application. The type must be a valid SPIisWebServiceApplicationPool object. @@ -81,8 +80,7 @@ The type must be a valid SPIisWebServiceApplicationPool object. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -92,6 +90,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly name for the new Excel Services Application Web service application. The name that you use must be a unique name of an Excel Services Application Web service application that is in this farm. The name can be a maximum of 128 characters. @@ -102,8 +103,7 @@ The type must be a valid string; for example, MyExcelServiceApp1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -113,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -135,14 +137,16 @@ Accept wildcard characters: False ``` ### -CachingOfUnusedFilesEnable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. The default is true when the parameter is not specified on the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -152,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +166,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -169,13 +175,15 @@ Accept wildcard characters: False ``` ### -CrossDomainAccessAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -185,13 +193,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that the proxy for this service application is added to the default proxy group of the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -201,6 +211,9 @@ Accept wildcard characters: False ``` ### -EncryptedUserConnectionRequired + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Requires that encryption is used between the end user and the Excel Services Application server. The scope of this setting is the logical server. The default value is None. @@ -210,8 +223,7 @@ The type must be one of the following: None or Connection. ```yaml Type: EncryptedConnectionMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -221,6 +233,9 @@ Accept wildcard characters: False ``` ### -ExternalDataConnectionLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. Valid values include: @@ -233,8 +248,7 @@ The default value is 1800. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -244,6 +258,9 @@ Accept wildcard characters: False ``` ### -FileAccessMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the authentication method that Excel Services Application uses to retrieve files. UseFileAccessAccount specifies that all workbooks always use the credentials of the service account running Excel Services Application. UseImpersonation specifies that Excel Services Application retrieves the workbook files as the user who is making the request. @@ -254,8 +271,7 @@ The type must be one of the following: UseImpersonation or UseFileAccessAccount. ```yaml Type: FileAccessMethod Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -265,6 +281,9 @@ Accept wildcard characters: False ``` ### -LoadBalancingScheme + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the load-balancing schema that is used by the Excel Services Application Web service application for sending requests to different back-end computers that are running Excel Calculation Services. The default value is WorkbookURL. @@ -273,8 +292,7 @@ The type must be one of the following: RoundRobin, Local, or WorkbookURL. ```yaml Type: LoadBalancingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -284,6 +302,9 @@ Accept wildcard characters: False ``` ### -MemoryCacheThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. When the memory cache threshold is exceeded, cached objects that are not currently in use are released. Setting this value to 0 disables caching of inactive objects. @@ -294,8 +315,7 @@ The type must be an integer in the range of 0 to 95. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -305,6 +325,9 @@ Accept wildcard characters: False ``` ### -PrivateBytesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum private bytes, in megabytes, used by Excel Services Application. When set to -1, the maximum private bytes defaults to 50 percent of physical memory on the computer. Valid values include -1 for no limit, and any positive integer. @@ -315,8 +338,7 @@ The type must be -1 or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -326,6 +348,9 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of sessions allowed for a user. If a user reaches this maximum, the oldest session will be deleted when a new session is started. Valid values include -1 for no limit, and any positive integer. @@ -336,8 +361,7 @@ The type must be -1 or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -347,6 +371,9 @@ Accept wildcard characters: False ``` ### -SiteCollectionAnonymousSessionsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of anonymous sessions allowed per site collection. A value of 0 specifies that no anonymous sessions are allowed. Valid values include -1 for no limit, 0 to disable the setting, or any positive integer. @@ -357,8 +384,7 @@ The type must be -1, 0, or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -368,13 +394,15 @@ Accept wildcard characters: False ``` ### -TerminateProcessOnAccessViolation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Terminates Excel Services Application when an access violation occurs in the process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -384,6 +412,9 @@ Accept wildcard characters: False ``` ### -ThrottleAccessViolationsPerSiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that if a workbook causes an access violation error on Excel Services Application, all files that originate from that workbook's site collection are blocked from loading for the specified period (in seconds). Existing sessions for files on that site collection are unaffected. Valid values include 0 to disable the setting, and the range of 1 to 2073600 seconds (24 days). @@ -394,8 +425,7 @@ The type must be an integer value in the range of 0 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -405,6 +435,9 @@ Accept wildcard characters: False ``` ### -UnattendedAccountApplicationId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that the application ID that is used to look up the unattended service account credentials from the secure store service specified by UnattendedAccountSecureServiceAppName. The secure store service is contacted when this parameter is set and specific error cases occur. Valid values are alphanumeric strings with a maximum of 256 characters. @@ -418,8 +451,7 @@ An unattended account is required when workbook connections specify None for aut ```yaml Type: String Parameter Sets: ExistingTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -429,6 +461,9 @@ Accept wildcard characters: False ``` ### -UnusedObjectAgeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. Valid values include -1 for no maximum setting, and a positive integer in the range of 1 to 34560 minutes (24 days). The default value is -1. @@ -438,8 +473,7 @@ The type must be -1, or an integer in the range of 1 to 34560. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -449,6 +483,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -456,7 +493,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -466,6 +502,9 @@ Accept wildcard characters: False ``` ### -WorkbookCache + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the local file system location of the cache that is used for storing workbooks used by Excel Services Application. If no value is specified, then the default value is a subdirectory in the system temporary directory. @@ -478,8 +517,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -489,6 +527,9 @@ Accept wildcard characters: False ``` ### -WorkbookCacheSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum allowable size, in megabytes, of an individual session. The default value is 0. @@ -497,8 +538,7 @@ The type must be any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -508,13 +548,15 @@ Accept wildcard characters: False ``` ### -UnattendedServiceAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + {{Fill UnattendedServiceAccount Description}} ```yaml Type: PSCredential Parameter Sets: NewTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -524,13 +566,15 @@ Accept wildcard characters: False ``` ### -UseEffectiveUserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + {{Fill UseEffectiveUserName Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -540,13 +584,15 @@ Accept wildcard characters: False ``` ### -WorkbookModelUsageTracker + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + {{Fill WorkbookModelUsageTracker Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelUserDefinedFunction.md index 9f1686bfc..8ee0f9585 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelUserDefinedFunction.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPExcelUserDefinedFunction.md @@ -7,7 +7,7 @@ title: New-SPExcelUserDefinedFunction schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPExcelUserDefinedFunction @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new user-defined function to Excel Services Application. - ## SYNTAX ``` @@ -25,7 +24,7 @@ New-SPExcelUserDefinedFunction -Assembly -ExcelServiceApplication Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the strongly typed name of the assembly. The name must be unique in the list of user-defined functions. The name can be a maximum of 4096 alphanumeric characters. @@ -62,8 +62,7 @@ The type must be a string of alphanumeric characters; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the list of user-defined functions. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -80,8 +82,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the location where the assembly is stored. The default value is GAC. @@ -99,8 +103,7 @@ The type must be one of the following: GAC or LocalFile. ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the user-defined function. The name can be a maximum of 4096 alphanumeric characters. The default value is an empty string. @@ -158,8 +168,7 @@ The type must be a valid string of alphanumeric characters; for example, this is ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -169,14 +178,16 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Activates the user-defined function for use with Excel Services Application. The default value is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -193,7 +207,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPLogFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPLogFile.md index 8b1bac89d..2bd0ba7cf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPLogFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPLogFile.md @@ -7,7 +7,7 @@ title: New-SPLogFile schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPLogFile @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new log file. - ## SYNTAX ``` @@ -27,20 +26,21 @@ The `New-SPLogFile` cmdlet ends the current log file and starts a new log file. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPLogFile ``` This example ends the current log file and starts a new log file. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedAccount.md index 7f9e9f606..db4f7ca77 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedAccount.md @@ -7,7 +7,7 @@ title: New-SPManagedAccount schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPManagedAccount @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Registers a new managed account. - ## SYNTAX ``` @@ -23,16 +22,14 @@ New-SPManagedAccount [-Credential] [-AssignmentCollection ] ``` - ## DESCRIPTION The `New-SPManagedAccount` cmdlet registers a new managed account for the specified Credential or Username and Password. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $cred = Get-Credential New-SPManagedAccount -Credential $cred @@ -40,18 +37,19 @@ New-SPManagedAccount -Credential $cred This example adds a new managed account to the farm by using credentials that are prompted. - ## PARAMETERS ### -Credential + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates the Credential object that specifies the credentials of the new managed account. If you use Credential, you cannot specify Username and Password. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,13 +83,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -106,7 +111,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedPath.md index 3e6ea01f4..c64eddcb6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPManagedPath.md @@ -7,7 +7,7 @@ title: New-SPManagedPath schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPManagedPath @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new managed path for the given Web application for all host header site collections. - ## SYNTAX ### HostHeader @@ -43,20 +42,21 @@ If the Explicit parameter is not provided, the new managed path is a wildcard pa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPManagedPath "Teams" -WebApplication "https://somesite" ``` This example creates a Teams managed path for a given Web application (https://somesite). - ## PARAMETERS ### -RelativeURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the relative URL for the new managed path. The type must be a valid partial URL such as site or sites/teams/. @@ -64,8 +64,7 @@ The type must be a valid partial URL such as site or sites/teams/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -75,13 +74,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If this parameter is provided, this managed path applies to all host header site collections. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application group to add this path. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-5678-0987645a. @@ -98,8 +102,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +126,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Explicit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the managed path is explicit or wildcard. If not provided, the managed path is a wildcard path. @@ -155,8 +165,7 @@ If not provided, the managed path is a wildcard path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMarketplaceWebServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMarketplaceWebServiceApplicationProxy.md index 5f1b32d3b..e1b98e717 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMarketplaceWebServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMarketplaceWebServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPMarketplaceWebServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPMarketplaceWebServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a service application proxy for the app identity data web service. - ## SYNTAX ``` @@ -29,27 +28,27 @@ Use the `New-SPMarketplaceWebServiceApplicationProxy` cmdlet to create a service For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPMarketplaceWebServiceApplicationProxy -Name ApplicationIdentityData -ServiceEndpointUri http://server:7800/ApplicationIdentityData.svc -DefaultProxyGroup ``` This example adds a proxy named ApplicationIdentityData to the app identity web service. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -ServiceEndpointUri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the app identity data web service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to add the service application proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplication.md index 8fc44d825..d66a24184 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPMetadataServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPMetadataServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new managed metadata service application. - ## SYNTAX ### NoQuota @@ -46,18 +45,16 @@ Use the `New-SPMetadataServiceApplication` cmdlet to create a new managed metada For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1------------- +### EXAMPLE 1 ``` New-SPMetadataServiceApplication -Name "MetadataServiceApp1" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB1" ``` This example creates a new managed metadata service application. - -### -------------------EXAMPLE 2------------- +### EXAMPLE 2 ``` New-SPMetadataServiceApplication -Name "MetadataServiceApp2" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB2" -HubUri "https://sitename" -SyndicationErrorReportEnabled ``` @@ -65,26 +62,26 @@ New-SPMetadataServiceApplication -Name "MetadataServiceApp2" -ApplicationPool "A This example creates a new managed metadata service application and specifies a content type hub to be used for syndication. It also enables error reporting during syndication. - -### -------------------EXAMPLE 3------------- +### EXAMPLE 3 ``` New-SPMetadataServiceApplication -Name "MetadataServiceApp3" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB3" -PartitionMode ``` This example creates a new managed metadata service application that is partitioned, for use by sites in a subscription. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application to create. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,14 +91,16 @@ Accept wildcard characters: False ``` ### -AdministratorAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A comma-separated list of user accounts or service accounts in the format \\\\ that may create and run the service application. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +110,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an existing IIS application pool in which to run the new managed metadata service application. The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool, or an instance of an SPServiceApplicationPool object. @@ -118,8 +120,7 @@ The value must be a GUID that is the identity of an SPServiceApplicationPool obj ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -129,6 +130,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -140,8 +144,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +154,9 @@ Accept wildcard characters: False ``` ### -CacheTimeCheckInterval + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an interval, in seconds, that a front-end Web Server should wait before asking the application server for changes. This value is set per timer job, client application, or Web application. @@ -160,8 +166,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -188,6 +195,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If SQL authentication is to be used, either DatabaseCredentials must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. @@ -197,8 +207,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +217,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the new managed metadata service application. The type must be a valid name of a SQL Server database; for example MeatadataDB1. @@ -215,8 +227,7 @@ The type must be a valid name of a SQL Server database; for example MeatadataDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +237,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid name of a SQL Server database; for example SqlServerHost1. @@ -233,8 +247,7 @@ The type must be a valid name of a SQL Server database; for example SqlServerHos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +257,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -251,8 +267,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +277,16 @@ Accept wildcard characters: False ``` ### -FullAccessAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read/write permission to the managed metadata service's term store and content type gallery. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -279,13 +296,15 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -295,6 +314,9 @@ Accept wildcard characters: False ``` ### -MaxChannelCache + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server should hold open to the application server. This value is set per timer job, client application, or Web application. @@ -304,8 +326,7 @@ The minimum value is 0, and there is no maximum value. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +336,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restrict data by subscription. Note This property cannot be changed after the service application has been created. @@ -324,8 +348,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -335,6 +358,9 @@ Accept wildcard characters: False ``` ### -ReadAccessAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read-only permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -342,8 +368,7 @@ The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -353,15 +378,17 @@ Accept wildcard characters: False ``` ### -RestrictedAccount -Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery; and permission to write to open term sets and local term sets and to create new enterprise keywords. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery; and permission to write to open term sets and local term sets and to create new enterprise keywords. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -371,13 +398,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables reporting of errors when content types are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +416,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -394,7 +426,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -404,13 +435,15 @@ Accept wildcard characters: False ``` ### -DisablePartitionQuota + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Disables partition quotas. ```yaml Type: SwitchParameter Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -420,13 +453,15 @@ Accept wildcard characters: False ``` ### -GroupsPerPartition + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of Term Groups per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -436,13 +471,15 @@ Accept wildcard characters: False ``` ### -LabelsPerPartition + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of Labels per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -452,13 +489,15 @@ Accept wildcard characters: False ``` ### -PropertiesPerPartition + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of Properties per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -468,13 +507,15 @@ Accept wildcard characters: False ``` ### -TermSetsPerPartition + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of Term Sets per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -484,12 +525,14 @@ Accept wildcard characters: False ``` ### -TermsPerPartition + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of Terms per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -499,13 +542,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplicationProxy.md index e68a20d75..1a6ca5ef7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPMetadataServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new connection to a managed metadata service application. - ## SYNTAX ``` @@ -22,42 +21,40 @@ New-SPMetadataServiceApplicationProxy -Name [-AssignmentCollection ] [-Uri ] [-WhatIf] [] ``` - ## DESCRIPTION Use the `New-SPMetadataServiceApplicationProxy` cmdlet to create a new connection to a managed metadata service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------- +### EXAMPLE 1 ``` New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy1" -ServiceApplication "MetadataServiceApp1" ``` This example creates a connection to a managed metadata service application in the local farm. - -### -------------------EXAMPLE 2---------------- +### EXAMPLE 2 ``` New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy3" -ServiceApplication "MetadataServiceApp3" -PartitionMode ``` This example creates a partitioned connection to a managed metadata service application in the local farm. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the service application proxy to create. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -67,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -89,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -106,13 +107,15 @@ Accept wildcard characters: False ``` ### -ContentTypePushdownEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that existing instances of changed content types in subsites and libraries will be updated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -ContentTypeSyndicationEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the connection be added to the default proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -DefaultKeywordTaxonomy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -DefaultSiteCollectionTaxonomy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restrict data by subscription. This property cannot be changed after the service application proxy has been created. @@ -193,8 +207,7 @@ This property cannot be changed after the service application proxy has been cre ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local managed metadata service application to connect to. The service application must exist on the local farm. @@ -212,8 +228,7 @@ The type must be a valid GUID; a valid name of the service application; or an in ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +238,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of a remote managed metadata service application to connect to. To specify the managed metadata service application that this proxy is connecting to, you must set only the URI parameter or only the ServiceApplication parameter. @@ -232,8 +250,7 @@ The type must be a valid URL, in the form urn:schemas-microsoft-com:sharepoint:s ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -250,7 +270,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplication.md index ca2a5374e..44dba0053 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPPerformancePointServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPPerformancePointServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new service application for the PerformancePoint Service. - ## SYNTAX ``` @@ -40,20 +39,21 @@ The `New-SPPerformancePointServiceApplication` cmdlet creates a new PerformanceP For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE------------------------ +### EXAMPLE ``` New-SPPerformancePointServiceApplication -Name PPS_Application_01 -ApplicationPool PPS_Application_Pool_01 ``` This example creates a new PerformancePoint Service application named PPSApp_01 and sets it to run under an application pool named PPS_Application_Pool_01. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new PerformancePoint Service application. The type must be a valid name of a PerformancePoint Service application; for example, PerfPointApp1. @@ -61,8 +61,7 @@ The type must be a valid name of a PerformancePoint Service application; for exa ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool to run the Web service in for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -79,8 +81,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +91,9 @@ Accept wildcard characters: False ``` ### -AnalyticQueryCellMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of returned cells in an analytic grid. A valid integer value from 1 through 1,000,000,000. @@ -98,8 +102,7 @@ The default value is 100,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -AnalyticQueryLoggingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on verbose logging of query events. The type must be one of the following: True or False. @@ -117,8 +123,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +133,16 @@ Accept wildcard characters: False ``` ### -ApplicationCacheEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the rendered output cache on the application server is on (True) or off (False). The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +152,16 @@ Accept wildcard characters: False ``` ### -ApplicationCacheMinimumHitCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the minimum number of times rendered output must be requested before it is added to cache. The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +171,16 @@ Accept wildcard characters: False ``` ### -ApplicationProxyCacheEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies rendered output cache on the front end Web server. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -190,8 +204,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +214,9 @@ Accept wildcard characters: False ``` ### -CommentsDisabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that users can add comments to scorecard cells. The type must be one of the following: true or false. @@ -208,8 +224,7 @@ The type must be one of the following: true or false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -CommentsScorecardMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of comments that can be added to a scorecard. The default value is 1000. @@ -227,8 +245,7 @@ The type must be an integer value from 1 through 1,000,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -238,6 +255,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -245,7 +265,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -255,6 +274,9 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server that contains the PerformancePoint Services database that must be mirrored. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). @@ -262,8 +284,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -273,6 +294,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the PerformancePoint Services database that will be created when the service application is provisioned. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). @@ -280,8 +304,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -291,6 +314,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server where the PerformancePoint Services database will be created. This should be the same server name that is used for the SharePoint content and configuration databases. @@ -301,8 +327,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -312,6 +337,9 @@ Accept wildcard characters: False ``` ### -DatabaseSQLAuthenticationCredential + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether to use Windows authentication or SQL Server authentication when connecting to a PerformancePoint Services database. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). @@ -319,8 +347,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -DataSourceQueryTimeoutSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in seconds, before a data source query times out. The default value is 300. @@ -338,8 +368,7 @@ The type must be an integer value in the range of 1 to 36,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -349,6 +378,9 @@ Accept wildcard characters: False ``` ### -DecompositionTreeMaximum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items (per level) returned to the decomposition tree visualization. A valid integer value from 1 through 1,000,000. @@ -357,8 +389,7 @@ The default value is 25. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -368,14 +399,16 @@ Accept wildcard characters: False ``` ### -ElementCacheSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the first class object cache expiration time. The default value is 15. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -385,6 +418,9 @@ Accept wildcard characters: False ``` ### -FilterRememberUserSelectionsDays + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days that user filter selections are remembered. The default value is 90. @@ -393,8 +429,7 @@ The type must be an integer value from 1 through 10,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -404,6 +439,9 @@ Accept wildcard characters: False ``` ### -FilterTreeMembersMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of records to show in filter treeview control. The default value is 500. @@ -412,8 +450,7 @@ The type must be an integer value from 1 through 100,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -423,6 +460,9 @@ Accept wildcard characters: False ``` ### -IndicatorImageCacheSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in seconds, that key performance indicator (KPI) icons are cached. The default value is 10. @@ -431,8 +471,7 @@ The type must be an integer value from 1 through 3,600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -442,6 +481,9 @@ Accept wildcard characters: False ``` ### -MSMQEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that notifications are sent to Microsoft Message Queuing (MSMQ) on content change. The type must be one of the following: true or false. @@ -450,8 +492,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -461,6 +502,9 @@ Accept wildcard characters: False ``` ### -MSMQName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the queue. The queue name can contain a maximum of 380 characters, and cannot contain the following characters: CR (ASCII 13), LF (ASCII 10), backslash (\\), plus sign (+, comma (,), or quotation marks (""). @@ -469,8 +513,7 @@ The type must be a valid MSMQ name; for example, MessageQueue1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -480,6 +523,9 @@ Accept wildcard characters: False ``` ### -SelectMeasureMaximum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of measures to show in a dashboard Select Measure control. The default value is 1000. @@ -488,8 +534,7 @@ The type must be an integer value from 1 through 1,000,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -499,6 +544,9 @@ Accept wildcard characters: False ``` ### -SessionHistoryHours + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of hours between clearing expired user navigation history. The default value is 2. @@ -507,8 +555,7 @@ The type must be an integer value from 1 through 48. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -518,6 +565,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsInitialRows + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the initial number of rows to retrieve for show details. The default value is 1,000. @@ -526,8 +576,7 @@ The type must be an integer value from 1 through 100,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -537,6 +586,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsMaxRows + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of rows to retrieve for show details. The type must be an integer value from 1 through 1,000,000. @@ -545,8 +597,7 @@ The default value is 10,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -556,6 +607,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsMaxRowsDisabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns off the ShowDetailsInitialRows setting. If set to True, Analysis Services controls limit. @@ -565,8 +619,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -576,6 +629,9 @@ Accept wildcard characters: False ``` ### -TrustedContentLocationsRestricted + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only specified locations are trusted. The default setting is false (trust all content locations). @@ -585,8 +641,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -596,6 +651,9 @@ Accept wildcard characters: False ``` ### -TrustedDataSourceLocationsRestricted + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only specified locations are trusted. The default setting is false (trust all data source locations). @@ -605,8 +663,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -616,6 +673,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -623,7 +683,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -633,6 +692,9 @@ Accept wildcard characters: False ``` ### -AnalyticResultCacheMinimumHitCount + +> Applicable: harePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The minimum number of times an analytic report needs to be accessed before caching starts happening. The default value is 0. @@ -640,8 +702,7 @@ The default value is 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: harePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -651,13 +712,15 @@ Accept wildcard characters: False ``` ### -DataSourceUnattendedServiceAccountTargetApplication + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The name of the Secure Store Application that will be used by default to access data sources. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -667,6 +730,9 @@ Accept wildcard characters: False ``` ### -FilterSearchResultsMax + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The maximum number of items to return on a Dashboard when viewing a filter. The default value is 5000. @@ -674,8 +740,7 @@ The default value is 5000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -685,15 +750,17 @@ Accept wildcard characters: False ``` ### -UseEffectiveUserName + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Enables the use of the Analysis Services Effective User Name feature. The type must be one of the following: True or False. The default value is False. - + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationProxy.md index 8801bae3b..7169d3ae4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPPerformancePointServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPPerformancePointServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a proxy for a PerformancePoint Service application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `New-SPPerformancePointServiceApplicationProxy` cmdlet creates a proxy for a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE-------------------- +### EXAMPLE ``` New-SPPerformancePointServiceApplicationProxy -Name PPS_Application_Proxy_01 -ServiceApplication PPS_Application_01 -Default ``` This example creates a new PerformancePoint Service application proxy named PPS_Application_Proxy_01, associated with the service application named PPS_Application_01 and is added to the Default proxy group. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the PerformancePoint Service application proxy to create. The type must be a valid name of a PerformancePoint Service application proxy; for example, PerfPointAppProxy1. @@ -50,8 +50,7 @@ The type must be a valid name of a PerformancePoint Service application proxy; f ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application that is associated with the new service application proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -68,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new application proxy will be added to the default service application proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationTrustedLocation.md index 8c2bdcb22..f7d12c6ce 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationTrustedLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPerformancePointServiceApplicationTrustedLocation.md @@ -7,7 +7,7 @@ title: New-SPPerformancePointServiceApplicationTrustedLocation schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPPerformancePointServiceApplicationTrustedLocation @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new trusted location for a PerformancePoint Service application. - ## SYNTAX ``` @@ -32,10 +31,9 @@ The new trusted location can be a Content or Data Source trusted location type a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE--------------------- +### EXAMPLE ``` New-SPPerformancePointServiceApplicationTrustedLocation -ServiceApplication PPSApp_01 -url "https://Some_Valid_Site_URL" -Type Site -TrustedLocationType Content ``` @@ -43,10 +41,12 @@ New-SPPerformancePointServiceApplicationTrustedLocation -ServiceApplication PPSA This example creates a new TrustedLocation for the PPSApp_01 service application. This creates a Content trusted location of type Site with the specified URL. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application to which the new trusted location will be added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -TrustedLocationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of trusted locations to create. If TrustedLocationType is not specified, this cmdlet creates all the trusted locations for the specified PerformancePoint Service application. @@ -73,8 +75,7 @@ The type must be one of the following: Content or Data Source. ```yaml Type: TrustedFileType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of trusted location. The type must be one of the following: Site Collection, Site, Document Library, List @@ -91,8 +95,7 @@ The type must be one of the following: Site Collection, Site, Document Library, ```yaml Type: RepositoryLocationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,14 +105,16 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the trusted location site, site collection, site, document library, or list. The type must be a valid URL, in the form https://server_name, or https://server_name/sitecollection/site/list. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +138,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the new safe data provider. The type must be a valid string with a maximum of 4096 characters. @@ -165,8 +177,7 @@ The type must be a valid string with a maximum of 4096 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplication.md index 2617d5d15..0ecf5f3f9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPPowerPointConversionServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPPowerPointConversionServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a PowerPoint Conversion Service application. - ## SYNTAX ``` @@ -24,7 +23,6 @@ New-SPPowerPointConversionServiceApplication [-Name] [-Confirm] [-WhatIf] [] ``` - ## DESCRIPTION Use the `New-SPPowerPointConversionServiceApplication` cmdlet to create a new instance of a PowerPoint Conversion Service application by using the Name parameter. @@ -32,27 +30,27 @@ After the PowerPoint Conversion Service application is created, you can convert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPPowerPointConversionServiceApplication -Name "MyWorkgroupPPTApp" -ApplicationPool "SharePoint Web Services Default" ``` This example creates a new instance of the PowerPoint Conversion Service application named MyWorkgroupPPTApp and assigns it to the default application pool. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the PowerPoint Conversion Service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,13 +60,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Assigns an application pool that Internet Information Services (IIS) will use for this service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplicationProxy.md index d2f46371b..aee1f46ef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPPowerPointConversionServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPPowerPointConversionServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPPowerPointConversionServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a PowerPoint Conversion Service application proxy. - ## SYNTAX ``` @@ -28,27 +27,27 @@ New-SPPowerPointConversionServiceApplicationProxy [-Name] Use the `New-SPPowerPointConversionServiceApplicationProxy` cmdlet to create a PowerPoint Conversion Service application proxy. The service application proxy is instantiated on the front-end web server and acts as an intermediary between the client computer and the service application back end. - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPPowerPointConversionServiceApplicationProxy -Name "MyWorkgroupPPTAppProxy" -ServiceApplication "MyWorkgroupPPTApp" -AddtoDefaultGroup ``` This example creates a new instance of the PowerPoint Conversion Service application proxy named MyWorkgroupPPTAppProxy, binds it to the MyWorkgroupPPTApp service application and then adds it to the default service application proxy group - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service application to bind. ```yaml Type: SPPowerPointConversionServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,14 +75,16 @@ Accept wildcard characters: False ``` ### -AddToDefaultGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the newly created proxy to the default service application proxy group. If not specified, the proxy is not added to a group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +108,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplication.md index 66a902732..c327fa9f2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPProfileServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPProfileServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a User Profile Service Application to a farm. - ## SYNTAX ### Default @@ -51,20 +50,21 @@ The `New-SPProfileServiceApplication` cmdlet adds and creates a new profile serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync ``` This example creates a new User Profile Service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -72,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,6 +82,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name for the new User Profile Service application. The name must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 64 characters. @@ -92,8 +94,7 @@ The type must be a valid name of a service application; for example, UserProfile ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -114,8 +118,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -142,15 +147,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the My Site will be created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -159,20 +166,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -MySiteManagedPath -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -MySiteManagedPath Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -180,8 +177,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +187,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. @@ -199,8 +198,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -210,6 +208,9 @@ Accept wildcard characters: False ``` ### -ProfileDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. The type must be a valid PSCredential object. @@ -217,8 +218,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -228,13 +228,15 @@ Accept wildcard characters: False ``` ### -ProfileDBName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database where the User Profile database is created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +246,9 @@ Accept wildcard characters: False ``` ### -ProfileDBServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server where the User Profile database will be created. The type must be a valid name of a SQL Server database server. @@ -251,8 +256,7 @@ The type must be a valid name of a SQL Server database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -262,6 +266,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid PSCredential object. @@ -269,8 +276,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -280,14 +286,16 @@ Accept wildcard characters: False ``` ### -ProfileDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates a content database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +305,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database where the Profile Sync database will be created. The type must be a valid name of a SQL Server database; for example, ProfileSyncAppDB1. @@ -304,8 +315,7 @@ The type must be a valid name of a SQL Server database; for example, ProfileSync ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +325,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server that will host the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid name of a SQL Server host; for example, SQLServerProfileSyncHost1. @@ -322,8 +335,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerProfil ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -333,14 +345,16 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates a Profile Sync database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -350,6 +364,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -368,8 +385,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -379,6 +395,9 @@ Accept wildcard characters: False ``` ### -SocialDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. The type must be a valid PSCredential object. @@ -386,8 +405,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -397,6 +415,9 @@ Accept wildcard characters: False ``` ### -SocialDBName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database where the Social database will be created. The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. @@ -404,8 +425,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerSocial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -415,6 +435,9 @@ Accept wildcard characters: False ``` ### -SocialDBServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server that will host the Social database that is specified in SocialDBName. The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. @@ -422,8 +445,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerSocial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -433,14 +455,16 @@ Accept wildcard characters: False ``` ### -SocialDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates a Social database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -450,6 +474,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -457,7 +484,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -467,13 +493,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplicationProxy.md index e6467179c..01a188da6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProfileServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPProfileServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPProfileServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a User Profile Service application proxy on the local farm. - ## SYNTAX ### Application @@ -41,10 +40,9 @@ The proxy is added to the default proxy group for the local farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync New-SPProfileServiceApplicationProxy -Name 'User Profile Service Application Proxy' -ServiceApplication $sa -DefaultProxyGroup @@ -52,10 +50,12 @@ New-SPProfileServiceApplicationProxy -Name 'User Profile Service Application Pro This example creates a new User Profile Service application proxy. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local User Profile Service application that is associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription User Profile Service application (for example, ProfileSvcApp1); or an instance of a valid SPServiceApplication object. @@ -63,8 +63,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: Application -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,14 +73,16 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URI of the remote user profile service application this proxy should communicate with. This value is required only if you plan to connect a User Profile Service application from a remote farm. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,13 +135,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the User Profile Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name for the new User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -155,8 +165,7 @@ The type must be a name of a valid User Profile Service application proxy; for e ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +175,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -190,7 +204,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplication.md index 7cada5779..b13296db1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPProjectServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPProjectServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Project Server Service application. - ## SYNTAX ``` @@ -28,18 +27,16 @@ The `New-SPProjectServiceApplication` cmdlet creates a new Project Server Servic For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPProjectServiceApplication -Name "PsiApplication" -ApplicationPool "PsiApplicationPool" -Proxy ``` This example creates a Project Server Service application with the name PsiApplication and an application pool with the name PsiApplicationPool and it creates a Project Server Service application proxy for the application. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPIisWebServiceApplicationPool "PsiApplicationPool" | New-SPProjectServiceApplication -Name "PsiApplication" ``` @@ -47,10 +44,12 @@ Get-SPIisWebServiceApplicationPool "PsiApplicationPool" | New-SPProjectServiceAp This example creates a Project Server Service application with the name PsiApplication. The result is piped using an application pool object. - ## PARAMETERS ### -ApplicationPool + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the existing IIS application pool to run the Web service in for the new service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -58,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the name of the new Project Server Service application. The type must be a valid name of a Project Server Service application; for example, ProjectWebApp1. @@ -76,8 +77,7 @@ The type must be a valid name of a Project Server Service application; for examp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -87,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +101,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -109,13 +111,15 @@ Accept wildcard characters: False ``` ### -Proxy + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies that a proxy for new service application is automatically created. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplicationProxy.md index 3b8e75e43..b99662ccd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPProjectServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPProjectServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPProjectServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a proxy for a Project Server Service application. - ## SYNTAX ``` @@ -28,28 +27,28 @@ The `New-SPProjectServiceApplicationProxy` cmdlet creates a proxy for a Project For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### -------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` New-SPProjectServiceApplicationProxy -Name PsiApplicationProxy -ServiceApplication PsiApplication ``` This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication. - -### -------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPServiceApplication | ?{ $_.Name -eq "PsiApplication" } | New-SPProjectServiceApplicationProxy -Name "PsiApplicationProxy" -Default ``` This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication and adds the proxy to the Default proxy group. - ## PARAMETERS ### -Name + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the name of the new proxy. The type must be a valid name of a Project Server Service application proxy; for example, ProjectSvcProxy1. @@ -57,8 +56,7 @@ The type must be a valid name of a Project Server Service application proxy; for ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -68,6 +66,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the Project Server Service application to associate with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -76,7 +77,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: True Position: Named @@ -86,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPRequestManagementRuleCriteria.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPRequestManagementRuleCriteria.md index b68c6d29e..e92785804 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPRequestManagementRuleCriteria.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPRequestManagementRuleCriteria.md @@ -7,7 +7,7 @@ title: New-SPRequestManagementRuleCriteria schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPRequestManagementRuleCriteria @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates criteria for the rule to match. - ## SYNTAX ### CustomPropertyParameterSet @@ -39,10 +38,9 @@ For more information about how to use parameter sets, see [Cmdlet parameter sets Use the `New-SPRequestManagementRuleCriteria` cmdlet to create criteria for the rule to match. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPRequestManagementRuleCriteria -Property Host -Value Client01 -MatchType Equals ``` @@ -52,13 +50,15 @@ This example creates a new rule that matches the Host 'Client01'. ## PARAMETERS ### -Value + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a value for the rule to match. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -68,13 +68,15 @@ Accept wildcard characters: False ``` ### -CustomHeader + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom header for the rule. ```yaml Type: String Parameter Sets: CustomPropertyParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -Property + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a header for a value to match. The following are the valid values: @@ -107,8 +112,7 @@ The following are the valid values: ```yaml Type: SPRequestManagementRulePropertyType Parameter Sets: StandardParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -118,13 +122,15 @@ Accept wildcard characters: False ``` ### -CaseSensitive + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not the match is case sensitive. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 3 @@ -134,6 +140,9 @@ Accept wildcard characters: False ``` ### -MatchType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines operators for the match. The following are the valid values: @@ -149,8 +158,7 @@ The following are the valid values: ```yaml Type: SPRequestManagementRuleMatchType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 3 @@ -160,6 +168,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -171,8 +182,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplication.md index e0eb15575..34b0afe4d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplication.md @@ -7,7 +7,7 @@ title: New-SPSecureStoreApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSecureStoreApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Secure Store application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The `New-SPSecureStoreApplication` cmdlet creates a new Secure Store application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $usernameField = New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false $passwordField = New-SPSecureStoreApplicationField -Name "Password" -Type WindowsPassword -Masked:$true @@ -45,17 +43,18 @@ New-SPSecureStoreApplication -ServiceContext http://contoso -TargetApplication $ This example creates a new group target application ContosoTargetApplication and then a new application for that target application. This new application has two fields; UserName of type WindowsUserName and Password of type WindowsPassword. The user with identity janedoe on the CONTOSO domain is set as the target application administrator. - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for the target application. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -TargetApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies information about the target application. For example, the TargetApplication object includes data values for application name, display name, contact info, enable ticketing flag and URL address to set the credential. The schema for the TargetApplication object is defined in the ISecureSToreProviderExtended interface that exposes the target application metadata. @@ -72,8 +74,7 @@ The schema for the TargetApplication object is defined in the ISecureSToreProvid ```yaml Type: TargetApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -Administrator + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the administrator of the new Secure Store application. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +126,15 @@ Accept wildcard characters: False ``` ### -CredentialsOwnerGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claims object for the groups that own the group credentials. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +144,16 @@ Accept wildcard characters: False ``` ### -Fields + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the field information for the application. The default fields are username and password. ```yaml Type: TargetApplicationField[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -TicketRedeemer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ticket redeemer claim value. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplicationField.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplicationField.md index d9be8ffb9..55fb7cc1a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplicationField.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreApplicationField.md @@ -7,7 +7,7 @@ title: New-SPSecureStoreApplicationField schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSecureStoreApplicationField @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Secure Store application fields object. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `New-SPSecureStoreApplicationField` cmdlet creates a new Secure Store applic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false ``` @@ -39,17 +37,18 @@ New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked This example creates a new credential field of type WindowsUserName with the name UserName and the masked property (which when true will hide characters as they are typed in by the user) set to false. This cmdlet is typically used in conjunction with the `New-SPSecureStoreApplication` cmdlet. - ## PARAMETERS ### -Masked + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Masks the visible characters that are typed in the field. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new target application field. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of credential field to add to a target application. The type must be one of the following: UserName, Password, Pin, Key, Generic, WindowsUserName, or WindowsPassword. @@ -82,8 +86,7 @@ The type must be one of the following: UserName, Password, Pin, Key, Generic, Wi ```yaml Type: SecureStoreCredentialType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +110,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplication.md index 7a48fafa6..81abf0b6e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPSecureStoreServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSecureStoreServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Secure Store Service application in the farm. - ## SYNTAX ``` @@ -32,27 +31,27 @@ The `New-SPSecureStoreServiceApplication` cmdlet creates a new Secure Store Serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' ``` This example creates a new Secure Store Service application with the name Contoso Secure Store with auditing disabled and creates a database with the name ContosoSSDatabase on the given database server for use with the service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool to run the Web service in for the new service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -AuditingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on auditing for the Secure Store Service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new Secure Store Service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -AuditlogMaxSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days to retain the audit log. The type must be a valid integer. @@ -123,8 +131,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +196,16 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +215,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -216,14 +233,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -233,13 +252,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -249,6 +270,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. @@ -257,8 +281,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -268,13 +291,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Secure Store service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -284,6 +309,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -291,7 +319,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -301,13 +328,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplicationProxy.md index 0b7113d19..2921c5d3f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPSecureStoreServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSecureStoreServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Secure Store Service application proxy in the farm. - ## SYNTAX ### PipeBind @@ -46,10 +45,9 @@ The result of the `New-SPSecureStoreServiceApplication` cmdlet can be passed to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $sa = New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' New-SPSecureStoreServiceApplicationProxy -Name 'Secure Store Service Application Proxy' -ServiceApplication $sa @@ -57,8 +55,7 @@ New-SPSecureStoreServiceApplicationProxy -Name 'Secure Store Service Application This example creates a new Secure Store Service application and proxy. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $nameofproxy = "Connection to: HostedSecureStoreInParentFarm" $proxy = Get-SPServiceApplicationProxy | where {$_ -match $nameofproxy} @@ -71,17 +68,18 @@ $proxy.Update() This example converts an unpartitioned secure store service application proxy in the child to a partitioned one. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local Secure Store Service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +89,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of a remote Secure Store Service application associated with the new proxy. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -98,8 +99,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,13 +152,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application proxy be added to the farm's default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +170,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new service application proxy to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +188,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +198,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreTargetApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreTargetApplication.md index ea469c1df..bc501dee4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreTargetApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSecureStoreTargetApplication.md @@ -7,7 +7,7 @@ title: New-SPSecureStoreTargetApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSecureStoreTargetApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Secure Store target application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `New-SPSecureStoreTargetApplication` cmdlet creates a new Secure Store Targe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` New-SPSecureStoreTargetApplication -Name "ContosoTargetApplication" -FriendlyName "Contoso Target Application" -ApplicationType Group ``` This example creates a new group type target application with the given name and friendly display name. - ## PARAMETERS ### -ApplicationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of target application. The type must be one of the following: Individual, Group, IndividualWithTicketing, GroupWithTicketing, RestrictedIndividual, or RestrictedGroup. @@ -50,8 +50,7 @@ The type must be one of the following: Individual, Group, IndividualWithTicketin ```yaml Type: TargetApplicationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the new target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +110,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -ContactEmail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the contact information for the target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -SetCredentialsUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI for setting the user application credentials. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -138,8 +148,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -TimeoutInMinutes + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The time, in minutes, a ticket is valid if it is not redeemed by the target application. Make sure that the ticket time-out value is long enough to last between the time when the ticket is issued to the time that it is redeemed The default value is 2. @@ -157,8 +169,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationPool.md index 015c0bba4..b222bccaa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationPool.md @@ -7,7 +7,7 @@ title: New-SPServiceApplicationPool schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPServiceApplicationPool @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Web service application pool. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `New-SPServiceApplicationPool` cmdlet creates a new Web service application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account (Get-SPManagedAccount 'contoso\serviceAccount') ``` @@ -42,17 +40,18 @@ For the Account parameter, the name of a managed account in the farm can be give Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new Web service application pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -Account + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials that will be the identity of the new application pool. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationProxyGroup.md index 709feaf93..ee1e4fb37 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPServiceApplicationProxyGroup.md @@ -7,7 +7,7 @@ title: New-SPServiceApplicationProxyGroup schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPServiceApplicationProxyGroup @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new service application proxy group. - ## SYNTAX ``` @@ -28,27 +27,27 @@ The `New-SPServiceApplicationProxyGroup` cmdlet creates a new service applicatio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPServiceApplicationProxyGroup -Name RemoteProxyGroup ``` This example creates a new service application proxy with the name RemoteProxyGroup. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new service application proxy group. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSite.md index e3fcb2fb8..edc471422 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSite.md @@ -7,7 +7,7 @@ title: New-SPSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new site collection at the specified URL. - ## SYNTAX ``` @@ -35,18 +34,16 @@ This cmdlet can create site collections in either the SharePoint Server mode whi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPSite https://webApp/sites/test -OwnerAlias "DOMAIN\JDoe" -Language 1033 -Template STS#0 ``` This example creates an English site collection at https://\/sites/test that is owned by user DOMAIN\Jdow. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` $w = Get-SPWebApplication https://webApp New-SPSite https://www.contoso.com -OwnerAlias "DOMAIN\jdow" -HostHeaderWebApplication $w -Name "Contoso" -Template STS#0 @@ -55,26 +52,26 @@ New-SPSite https://www.contoso.com -OwnerAlias "DOMAIN\jdow" -HostHeaderWebAppli This example creates a host-named site collection. Because the template is provided, the root web of this site collection will be created. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` Get-SPWebTemplate | Where{ $_.Title -eq "Team Site" } | ForEach-Object{ New-SPSite https:///sites/testsite that is owned by user DOMAIN\Jdow - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL that the new site collection uses. If the URL is not a host header site, the URL must start with the web application URL. @@ -82,8 +79,7 @@ If the URL is not a host header site, the URL must start with the web applicatio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -93,6 +89,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user login name of the site owner. The type must be a valid user alias, in the form, Domain\username. @@ -100,8 +99,7 @@ The type must be a valid user alias, in the form, Domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -111,6 +109,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site type. Valid values are None or TentantAdministration. @@ -118,8 +119,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +129,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -140,8 +143,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,18 +153,19 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +175,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -189,6 +194,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or GUID of the content database in which to create the new site. If no content database is specified, the site collection is selected automatically. The type must be a valid database name in the form, SiteContent1212, or a GUID in the form, 1234-5678-9807. @@ -196,8 +204,7 @@ The type must be a valid database name in the form, SiteContent1212, or a GUID i ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,6 +214,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Describes the new site. If no value is specified, the value is left blank. @@ -214,8 +224,7 @@ If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +234,9 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that if the URL provided is to be a host-named site collection, the HostHeaderWebApplication parameter must be the name, URL, GUID, or SPWebApplication object for the web application in which this site collection is created. If no value is specified, the value is left blank. @@ -237,12 +249,10 @@ The type must be a valid name in one of the following forms: --A GUID (for example, 1234-5678-9876-0987) - ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,6 +262,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language ID for the new site collection. If no language is specified, the site collection is created with the same language that was specified when the product was installed. @@ -261,8 +274,7 @@ This must be a valid language identifier (LCID). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -272,6 +284,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the title of the new site collection. If no name is specified, the default name is applied. @@ -279,8 +294,7 @@ If no name is specified, the default name is applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -290,6 +304,9 @@ Accept wildcard characters: False ``` ### -OverrideCompatibilityRestriction + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to use compatibility restriction for site. The valid values are True or False. @@ -297,8 +314,7 @@ The valid values are True or False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -308,6 +324,9 @@ Accept wildcard characters: False ``` ### -OwnerEmail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the email address of site owner. If no value is specified, the value is left blank. @@ -316,8 +335,7 @@ The type must be a email address in the form, someone@example.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -327,6 +345,9 @@ Accept wildcard characters: False ``` ### -QuotaTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the quota template for the new site.The template must exist already. If no template is specified, no quota is applied. @@ -334,8 +355,7 @@ If no template is specified, no quota is applied. ```yaml Type: SPQuotaTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -345,6 +365,9 @@ Accept wildcard characters: False ``` ### -SecondaryEmail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the email address of the secondary site owner. If no value is specified, the value is left blank. The type must be a email address, in the form, someone@example.com. @@ -352,8 +375,7 @@ The type must be a email address, in the form, someone@example.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -363,6 +385,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user login credentials of the secondary site owner. If no value is specified, the value is left blank. @@ -372,8 +397,7 @@ The type must be a valid user alias, in the form, Domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -383,13 +407,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -399,6 +425,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web template for the root web of the new site collection. The template must be already installed. @@ -408,8 +437,7 @@ If no template is specified, no template is provisioned. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -419,6 +447,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -426,7 +457,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -436,6 +466,9 @@ Accept wildcard characters: False ``` ### -CreateFromSiteMaster + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to create a new site using the Site Master. The valid values are True or False. @@ -443,8 +476,7 @@ The valid values are True or False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteMaster.md index 9c9781336..2fac54573 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteMaster.md @@ -7,7 +7,7 @@ title: New-SPSiteMaster schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSiteMaster @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a site master. - ## SYNTAX ``` @@ -27,20 +26,21 @@ New-SPSiteMaster [-ContentDatabase] ## DESCRIPTION Use the New-SPSiteMaster cmdlet to create a site master information in the farm. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPSiteMaster -ContentDatabase WSS_Content -Template STS#0 ``` This example creates a site master in the database WSS_Content. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -66,8 +68,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create the site master in. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the locale ID to use. For example, use 1033 for English. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the template. The values are the following: @@ -146,8 +156,7 @@ The values are the following: ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +176,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscription.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscription.md index 125740705..0ecfb56b2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscription.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscription.md @@ -7,7 +7,7 @@ title: New-SPSiteSubscription schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSiteSubscription @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new site subscription. - ## SYNTAX ``` @@ -23,7 +22,7 @@ New-SPSiteSubscription [-AssignmentCollection ] [ Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscriptionFeaturePack.md index 824a1389b..0bee34914 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSiteSubscriptionFeaturePack.md @@ -7,7 +7,7 @@ title: New-SPSiteSubscriptionFeaturePack schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSiteSubscriptionFeaturePack @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new SharePoint Feature set that can be used to limit the features available to a site subscription. - ## SYNTAX ``` @@ -32,10 +31,9 @@ Feature sets contain a list of the GUIDs of each Feature that is on an Allow Lis For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $fs = New-SPSiteSubscriptionFeaturePack @@ -44,10 +42,12 @@ $fs = New-SPSiteSubscriptionFeaturePack This example creates a new SharePoint Feature Pack and stores it in a variable. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -59,8 +59,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -77,7 +79,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplication.md index d5010fc41..17d3ade84 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPStateServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPStateServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new state service application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ A state service application is the container for state service databases. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` $db = New-SPStateServiceDatabase -Name 'StateSvcDB1' New-SPStateServiceApplication -Name 'State Service' -Database $db @@ -43,6 +41,9 @@ This example creates a new state service database and a state service applicatio ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new service application. The type must be a valid name of a service application; for example, StateSvcApp1. @@ -50,8 +51,7 @@ The type must be a valid name of a service application; for example, StateSvcApp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database that is associated with the new service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -90,8 +95,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPStateDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplicationProxy.md index 8db40a10a..df64e82aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPStateServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPStateServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a proxy for a state service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `New-SPStateServiceApplicationProxy` cmdlet creates a proxy for a state serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE------------------- +### EXAMPLE ``` $db = New-SPStateServiceDatabase -Name 'State Service' $sa = New-SPStateServiceApplication -Name 'State Service' -Database $db @@ -40,10 +38,12 @@ New-SPStateServiceApplicationProxy -Name 'State Service Proxy' -ServiceApplicati This example creates a State Service database and Service Application. It then associates a new State Service Proxy with the State Service application and adds it to the Default proxy group. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to associate with the new proxy. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -51,8 +51,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application proxy is added to the farm's default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the new proxy. The type must be a valid name of a SQL Server database; for example, SessionStateDB1. @@ -108,8 +114,7 @@ Service application proxy; for example, StateSvcAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceDatabase.md index 7d74c3dc8..2111d9107 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPStateServiceDatabase.md @@ -7,7 +7,7 @@ title: New-SPStateServiceDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPStateServiceDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates and provisions a new state service database and installs the state database schema into it. - ## SYNTAX ``` @@ -30,10 +29,9 @@ This cmdlet installs the session state database schema in the state service data For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` New-SPStateServiceDatabase -Name 'State Service' ``` @@ -43,13 +41,15 @@ This example creates a new state service database. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name for the state service database that is stored in SQL Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -89,8 +94,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +104,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -107,8 +114,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +124,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to add the state database to. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -125,8 +134,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +144,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the weight for the state database. The default value is 1. @@ -146,8 +157,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplication.md index e1778bc8c..2140e2a47 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPSubscriptionSettingsServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSubscriptionSettingsServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new subscription settings service application. - ## SYNTAX ``` @@ -32,10 +31,9 @@ This cmdlet is used only in an environment where site subscriptions are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE--------------- +### EXAMPLE ``` $sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' @@ -48,6 +46,9 @@ This example creates a Subscriptions Settings Service application. ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS application pool to use for the new subscription settings application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -55,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -66,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,6 +109,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -112,8 +119,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +129,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the subscription settings database. If not provided, one will be generated. @@ -132,8 +141,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +151,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL Server instance for the database specified in the DatabaseName parameter. If not provided, the default database server will be used. @@ -153,8 +164,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +174,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -171,8 +184,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +194,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the friendly name of the new subscription settings service. The type must be a valid name of a subscription settings service application; for example, SubscriptionSettingsApp1. @@ -189,8 +204,7 @@ The type must be a valid name of a subscription settings service application; fo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +214,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -207,7 +224,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -217,13 +233,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplicationProxy.md index 1a520e9e8..49460b413 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPSubscriptionSettingsServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPSubscriptionSettingsServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPSubscriptionSettingsServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates an application proxy to a subscription settings service application. - ## SYNTAX ### ServiceApplication @@ -40,10 +39,9 @@ This is required for the local farm to consume a subscription settings service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------------- +### EXAMPLE ``` $sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $sa @@ -54,6 +52,9 @@ This example creates a new Subscription Settings Service application and proxy. ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the subscription settings service application associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -61,8 +62,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -72,6 +72,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the address of the subscription settings service application to associate the new application proxy with. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -79,8 +82,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -129,6 +135,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +145,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplication.md index 72bce1287..514ed4bf1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPTranslationServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPTranslationServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Provisions a new instance of the Machine Translation service. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Use the `New-SPTranslationServiceApplication` cmdlet to provision a new instance For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE--------------- +### EXAMPLE ``` New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase ``` @@ -41,17 +39,18 @@ New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'S This example creates a Machine Translation service application named TranslationService which will run in the SharePoint Web Services Default service application pool. The database will be called TranslationServiceDatabase and will be hosted on the Server1 SQL server instance. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier of Translation Service instance to be created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed application pool that the instance of Translation Service will run in. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,14 +121,16 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +140,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database name which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +158,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether or not the proxy for this service application should be added to the default proxy group for this Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +194,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,14 +212,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Restricts this service to behave uniquely on a partitioned set of site collections. This cannot be changed after the application is provisioned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -214,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -221,7 +241,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -231,13 +250,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplicationProxy.md index 970db125c..195238a7c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTranslationServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPTranslationServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPTranslationServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a Machine Translation Service application proxy on the local farm. - ## SYNTAX ### ConnectLocal @@ -42,10 +41,9 @@ The proxy is added to the default proxy group for the local farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ``` $sa = New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase New-SPTranslationServiceApplicationProxy -Name TranslationServiceProxy -ServiceApplication $sa -DefaultProxyGroup @@ -53,10 +51,12 @@ New-SPTranslationServiceApplicationProxy -Name TranslationServiceProxy -ServiceA This example creates a Machine Translation Service application and proxy in the default proxy group named TranslationServiceProxy. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name for the new Machine Translation Service application. The name that you use must be a unique name of a Machine Translation Service application in this farm. The name can be a maximum of 128 characters. @@ -64,8 +64,7 @@ The name can be a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +74,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local Machine Translation Service application that is associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Machine Translation Service application (for example, MachTrans1); or an instance of a valid SPServiceApplication object. @@ -82,8 +84,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: ConnectLocal -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,14 +94,16 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the remote machine translation service application this proxy should communicate with. This value is required only if you plan to connect a Machine Translation Service application from a remote farm. ```yaml Type: String Parameter Sets: ConnectRemote -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +174,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +193,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -189,7 +203,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedIdentityTokenIssuer.md index 693502ade..f0a82bcd3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedIdentityTokenIssuer.md @@ -7,7 +7,7 @@ title: New-SPTrustedIdentityTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPTrustedIdentityTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates an identity provider in the farm. - ## SYNTAX ### BasicParameterSet @@ -52,20 +51,21 @@ For security token service (STS) identity providers, this cmdlet creates and per For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ``` New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" - Description "LiveID STS" -Certificate (Get-ChildItem "cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") -SignInUrl https://int.contoso.com/ -IdentifierClaim "http://schemas.contoso.com/2007/05/Claims/Puid" ``` This example creates a new identity provider in the farm named LiveIDSTS. - ## PARAMETERS ### -ClaimsMappings + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the mapping of the claims from the original token to the SharePoint token. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. @@ -73,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind[] Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +83,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a description for the new identity provider. The type must be a valid string; for example, LiveID STS. @@ -91,8 +93,7 @@ The type must be a valid string; for example, LiveID STS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +103,9 @@ Accept wildcard characters: False ``` ### -IdentifierClaim + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which claim type from the trusted STS will be used for the new identity provider. The type must be a valid claim type from the trusted STS; for example, http://schemas.microsoft.com/2007/05/Claims/Puid. @@ -109,8 +113,7 @@ The type must be a valid claim type from the trusted STS; for example, http://sc ```yaml Type: String Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new identity provider. The type must be a valid name of an identity provider; for example, LiveIDSTS. @@ -127,8 +133,7 @@ The type must be a valid name of an identity provider; for example, LiveIDSTS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the realm, or resource partition, associated with this trust. The type must be a name of a valid realm; for example, MD_REALM. @@ -145,8 +153,7 @@ The type must be a name of a valid realm; for example, MD_REALM. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -SignInUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign-in URLs for this trusted STS identity provider. The type must be a valid URL, in the form https://int.live.com/. @@ -163,8 +173,7 @@ The type must be a valid URL, in the form https://int.live.com/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -174,6 +183,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -185,8 +197,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +207,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IP STS that can resolve and search claims for claims people picker. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. @@ -203,8 +217,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -214,6 +227,9 @@ Accept wildcard characters: False ``` ### -ImportTrustCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -221,8 +237,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -232,13 +247,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI for the metadata endpoint of the trusted provider. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -248,6 +265,9 @@ Accept wildcard characters: False ``` ### -UseWReply + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Includes a WReply with the token request. WReply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. @@ -255,8 +275,7 @@ WReply is a URL at the relying party to which the requestor is redirected once s ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -266,13 +285,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -282,6 +303,9 @@ Accept wildcard characters: False ``` ### -IdentifierClaimIs + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which of the default mapped claims should be used as the identifier claim. Only used if the UseDefaultConfiguration parameter is set to true, otherwise use the IdentifierClaim parameter. @@ -289,8 +313,7 @@ Only used if the UseDefaultConfiguration parameter is set to true, otherwise use ```yaml Type: String Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -300,13 +323,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Registered Issuer Name instead of not using the metadata endpoint. ```yaml Type: String Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -316,13 +341,15 @@ Accept wildcard characters: False ``` ### -SignOutUrl + +> Applicable: SSharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign out URI for the trusted provider. This lets SharePoint to sign the user out from the trusted provider when they sign out from SharePoint. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SSharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -332,6 +359,9 @@ Accept wildcard characters: False ``` ### -UseDefaultConfiguration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the default set of claim mappings should be used. If UseDefaultConfiguration parameter is used, then the IdentifierClaimIs parameter must be used. @@ -339,8 +369,7 @@ If UseDefaultConfiguration parameter is used, then the IdentifierClaimIs paramet ```yaml Type: SwitchParameter Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -350,6 +379,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -357,7 +389,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedRootAuthority.md index 4ecc5ea5d..019d02d5d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedRootAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a trusted root authority. - ## SYNTAX ### ManualUpdateCertificateParameterSet @@ -33,10 +32,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New-SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $cert @@ -44,10 +42,12 @@ New-SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $cert This example creates a new trusted root authority, WFEFarm1. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the trusted root authority to create. The value must be a valid name of a trusted root authority; for example, WFEFarm1. @@ -55,8 +55,7 @@ The value must be a valid name of a trusted root authority; for example, WFEFarm ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate of the trusted root authority. The value must be a name of a valid X.509 certificate; for example, Certificate1. @@ -73,8 +75,7 @@ The value must be a name of a valid X.509 certificate; for example, Certificate1 ```yaml Type: X509Certificate2 Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Uri of the metadata endpoint. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -145,7 +155,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedSecurityTokenIssuer.md index 49181c0ed..667285b84 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedSecurityTokenIssuer.md @@ -7,7 +7,7 @@ title: New-SPTrustedSecurityTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPTrustedSecurityTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a trust between a server to server principal. - ## SYNTAX ### ImportCertificateParameterSet @@ -41,27 +40,27 @@ Use the `New-SPTrustedSecurityTokenIssuer` cmdlet to establish a trust between a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ``` New-SPTrustedSecurityTokenIssuer -Name "SPFarmA" -MetadataEndPoint https://mysite/my/_layouts/metadata/test/1/ -isSelfIssuer "false" ``` This example creates a new trusted security token named SPFarmA. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -71,13 +70,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +88,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI for the metadata endpoint of the issuer. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -114,8 +120,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,13 +167,15 @@ Accept wildcard characters: False ``` ### -IsTrustBroker + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,13 +185,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the registered token issuer instead of using metadata endpoint. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -197,7 +213,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedServiceTokenIssuer.md index 776981d90..1a79e6074 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPTrustedServiceTokenIssuer.md @@ -7,7 +7,7 @@ title: New-SPTrustedServiceTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPTrustedServiceTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a trust with a SharePoint farm. - ## SYNTAX ### ImportCertificateParameterSet @@ -37,10 +36,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Certificate $cert @@ -48,10 +46,12 @@ New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Cert This example shows how to create a new SharePoint Farm trust using the trust certificate from a file. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the trust. The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1. @@ -59,8 +59,7 @@ The type must be a valid name of a trusted service issuer; for example, WFEFarmT ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a name of a valid X.509 certificate; for example, Certificate1. Specifies the X.509 certificate object from trusted authentication provider farm. @@ -77,8 +79,7 @@ Specifies the X.509 certificate object from trusted authentication provider farm ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. @@ -117,8 +123,7 @@ The type must be a valid string; for example, WFE Farm Trust1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI for the metadata endpoint of the trusted provider. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -167,7 +179,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageApplication.md index 1ec269ff1..23f2b2d96 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageApplication.md @@ -7,7 +7,7 @@ title: New-SPUsageApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUsageApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new usage application. - ## SYNTAX ``` @@ -30,20 +29,21 @@ The `New-SPUsageApplication` cmdlet creates a new usage application in the local For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------- +### EXAMPLE ``` New-SPUsageApplication -Name "Usage Application For Farm ABC" ``` This example creates a new usage application for the specified name. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the friendly name of the new usage application. The type must be a valid name of a usage application; for example, UsageApplication1. @@ -51,8 +51,7 @@ The type must be a valid name of a usage application; for example, UsageApplicat ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the logging database. If the logging database does not exist, a logging database is automatically created. @@ -109,8 +115,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -128,8 +136,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPServer object where the logging database is created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. @@ -146,8 +156,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -165,8 +177,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -183,8 +197,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -201,8 +217,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -219,7 +237,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageLogFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageLogFile.md index 465849d83..a4834d213 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageLogFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUsageLogFile.md @@ -7,7 +7,7 @@ title: New-SPUsageLogFile schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUsageLogFile @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Starts a new usage log file on the current server computer. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The usage data in memory is flushed to the current usage log file before the new For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------- +### EXAMPLE ``` New-SPUsageLogFile ``` This example terminates the current usage log file and creates a new one. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUser.md index 2b08c076d..ee6e52d2c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUser.md @@ -7,7 +7,7 @@ title: New-SPUser schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUser @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds an existing user to a SharePoint site with the designated permissions. - ## SYNTAX ``` @@ -34,18 +33,16 @@ If only an alias is given and the farm is in Active Directory Account Create mod For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` New-SPUser -UserAlias 'Contoso\Jdow'-DisplayName 'Jane Dow' -Web https://contoso.com ``` This example adds a new user named Jane Dow to the Contoso domain. - -### ------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPWeb https://sitename | New-SPUser -UserAlias Contoso\Jdow ``` @@ -53,17 +50,18 @@ Get-SPWeb https://sitename | New-SPUser -UserAlias Contoso\Jdow This example adds Contoso\Jdow to all webs in the https://sitename site collection. Because this site collection uses inherited permissions, only the top-level web site needs to be touched. - ## PARAMETERS ### -UserAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user alias from Active Directory Domain Services (AD DS). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +71,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the web on which to create this user. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-5678-9876-0987. @@ -80,8 +81,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +105,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,6 +134,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a string that contains the display name of the user. The type must be a valid user name; for example, Joe. @@ -137,8 +144,7 @@ The type must be a valid user name; for example, Joe. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +154,9 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the email address of the new user. The type must be a valid email address, in the form someone@contoso.com. @@ -155,8 +164,7 @@ The type must be a valid email address, in the form someone@contoso.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +174,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user group to which the new user belongs. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +192,9 @@ Accept wildcard characters: False ``` ### -PermissionLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a user to a permission level. The type must be a valid permission level for the web application; for example, Full Control, Read, Contribute, or All. @@ -189,8 +202,7 @@ The type must be a valid permission level for the web application; for example, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +212,15 @@ Accept wildcard characters: False ``` ### -SiteCollectionAdmin + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to add the user as an administrator to the site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +230,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -223,7 +240,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserLicenseMapping.md index 21480a836..e374de5cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserLicenseMapping.md @@ -7,7 +7,7 @@ title: New-SPUserLicenseMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUserLicenseMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a license mapping object. - ## SYNTAX ### TrustIdentity @@ -58,10 +57,9 @@ After the object is created you can pipe the result to the `Add-SPUserLicenseMap For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE---------------------------) +### EXAMPLE) ``` $a = New-SPUserLicenseMapping -SecurityGroup EntSecGroup -License Enterprise $a | Add-SPUserLicenseMapping @@ -69,18 +67,19 @@ $a | Add-SPUserLicenseMapping This example creates a license mapping object for the Active Directory secured group named 'EntSecGroup' and then pipes the result to the `Add-SPUserLicenseMapping` cmdlet. - ## PARAMETERS ### -Claim + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claims principal to license. The value must be an authentic claims principal. ```yaml Type: SPClaim Parameter Sets: TrustIdentity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,14 +89,16 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of the claim. The value must be an authentic name of a claim type. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -107,14 +108,16 @@ Accept wildcard characters: False ``` ### -License + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of a supported SharePoint user license. For the full list of supported licenses on a SharePoint farm, see the `Get-SPUserLicense` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -124,14 +127,16 @@ Accept wildcard characters: False ``` ### -OriginalIssuer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the original issuer of the claim. The value must be the authentic name of an original issuer. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -141,14 +146,16 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of a forms-based role. The value must be an authentic name of a forms-based role. ```yaml Type: String Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -158,14 +165,16 @@ Accept wildcard characters: False ``` ### -RoleProviderName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of a role provider. The value must be an authentic name of a role provider. ```yaml Type: String Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -175,14 +184,16 @@ Accept wildcard characters: False ``` ### -SecurityGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of an AD DS security group. The value must be a name of an Active Directory security group. ```yaml Type: String Parameter Sets: WindowsAuth -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -192,14 +203,16 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value of the claim. The value must be an authentic claim value. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -220,8 +236,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -231,6 +246,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -238,7 +256,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -248,14 +265,16 @@ Accept wildcard characters: False ``` ### -ValueType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value type of the claim. The value must be an authentic name of a claim value type. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -265,6 +284,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, web application name, or web application object instance where the mapping is to be added. If you omit this parameter, the mapping is applied to the entire farm. @@ -273,8 +295,7 @@ The type must be an URL in the form http://server_name or http://server_name/sit ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -284,6 +305,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -291,7 +315,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSettingsProvider.md index dfa3ba76b..f4bbe1afe 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSettingsProvider.md @@ -7,7 +7,7 @@ title: New-SPUserSettingsProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUserSettingsProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new User Settings Provider. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use the `New-SPUserSettingsProvider` cmdlet to add a new User Settings Provider For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ``` New-SPUserSettingsProvider -DisplayName "My User Settings Provider" -AssemblyName MyProvider.dll -Type MyProvider ``` This example adds a user setting provider with a display name of "My User Settings Provider" which uses the MyProvider.dll file. - ## PARAMETERS ### -AssemblyName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the assembly name for the provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name to use for this provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type name to use for this provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +107,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSolutionAllowList.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSolutionAllowList.md index c8e0e91e9..6f1240b6a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPUserSolutionAllowList.md @@ -7,7 +7,7 @@ title: New-SPUserSolutionAllowList schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPUserSolutionAllowList @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a user managed solutions gallery. - ## SYNTAX ``` @@ -26,19 +25,20 @@ New-SPUserSolutionAllowList [-AssignmentCollection ] [-C ## DESCRIPTION Creates a user managed solutions gallery. - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ``` New-SPUserSolutionAllowList -Site https://contoso/sites/site1 -ListTitle "Allow List" ``` This example creates a user managed solutions gallery named "Allow List" under the root web of the site collection at https://contoso/sites/site1. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -73,13 +74,15 @@ Accept wildcard characters: False ``` ### -ListTitle + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the title of the user solution allow list to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,13 +92,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the user solution allow list will be created. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,6 +110,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -112,7 +120,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioSafeDataProvider.md index f69d75957..219359cfc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioSafeDataProvider.md @@ -7,7 +7,7 @@ title: New-SPVisioSafeDataProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPVisioSafeDataProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new data provider to a Visio Services application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `New-SPVisioSafeDataProvider` cmdlet adds a new data provider to the list of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ``` New-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 -Description "Custom Data Provider" ``` This example creates a new safe data provider for a specified Visio Services application. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the data provider to create. The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -52,8 +52,7 @@ The type must be a valid string that identifies the data provider; for example, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid identity of a data provider type. Specifies the supported type of the data provider to add. @@ -71,8 +73,7 @@ Custom data types are supported; for example, Excel Services. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application in which to add the new safe data provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -89,8 +93,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +117,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the new safe data provider. The type must be a string with a maximum of 4096 characters. @@ -129,8 +137,7 @@ The type must be a string with a maximum of 4096 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplication.md index 9ce9419c8..328fbceec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPVisioServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPVisioServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new Visio Services application to a farm. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `New-SPVisioServiceApplication` cmdlet adds a new Visio Services application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' -CreateDefaultProxy ``` This example creates a new Visio Services application named 'Visio Graphics Service Application' and also creates a service application proxy associated with it. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -AddToDefaultGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that a default proxy is created for the new Visio Services application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application to create. The type must be a valid name of a Visio Service application; for example, MyVisioService1. @@ -122,8 +130,7 @@ The type must be a valid name of a Visio Service application; for example, MyVis ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplicationProxy.md index 7b0b814e0..8424f3f61 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPVisioServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPVisioServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPVisioServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds a new Visio Services application proxy to a farm. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `New-SPVisioServiceApplicationProxy` cmdlet adds a new Visio Services applic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------ +### EXAMPLE ``` $sa = New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' New-SPVisioServiceApplicationProxy -Identity 'Visio Graphics Service Application Proxy' -ServiceApplication $sa @@ -39,10 +37,12 @@ New-SPVisioServiceApplicationProxy -Identity 'Visio Graphics Service Application This example creates a new Visio Services application proxy connected to a Visio Services application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that is associated with the application proxy. The type must be a valid name of a Visio Services application; for example, MyVisioService1. @@ -50,8 +50,7 @@ The type must be a valid name of a Visio Services application; for example, MyVi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application proxy to create. The type must be a valid name of a Visio Services application; for example, MyVisioService1. @@ -90,8 +94,7 @@ The type must be a valid name of a Visio Services application; for example, MyVi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPIBinding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPIBinding.md index e42026b41..3e9491c22 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPIBinding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPIBinding.md @@ -7,7 +7,7 @@ title: New-SPWOPIBinding schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWOPIBinding @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new binding to associate file name extensions or applications with actions on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -35,27 +34,28 @@ If you run `New-SPWOPIBinding` for an application or file name extension where t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" ``` This example creates bindings for all the applications and file name extensions that the WOPI application supports on the current SharePoint farm where this cmdlet is run. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" -Application "Excel" ``` This example associates Excel with all the actions that the WOPI application supports for Excel on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -ServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or fully qualified domain name (FQDN) of the WOPI application (such as a server that runs Office Web Apps Server). This can also be an FQDN of a load balanced endpoint for multiple Office Web Apps servers. @@ -63,8 +63,7 @@ This can also be an FQDN of a load balanced endpoint for multiple Office Web App ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,6 +73,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the action to bind. For example, "view," "edit," and "embedview." For a list of actions that the WOPI application supports, run `Get-SPWOPIBinding`. @@ -84,8 +86,7 @@ If you specify some actions but not others, some SharePoint features may not wor ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +96,9 @@ Accept wildcard characters: False ``` ### -AllowHTTP + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the cmdlet can use HTTP for discovery of what the WOPI application supports. If this is specified as True, the discovery information from the WOPI application will be sent on a nonsecure connection. @@ -102,8 +106,7 @@ If this is specified as True, the discovery information from the WOPI applicatio ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies applications to bind. Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the full list of application the WOPI application supports. @@ -120,8 +126,7 @@ Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -138,8 +146,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +166,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,6 +175,9 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extensions to bind. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. @@ -173,8 +185,7 @@ Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI applica ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of the xml file that contains the discover information for the WOPI application. You can load discovery information from an xml file instead of requesting from the WOPI application directly. @@ -191,8 +205,7 @@ You can load discovery information from an xml file instead of requesting from t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the programmatic identifier (ProgID) for an application to bind. Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. @@ -211,8 +227,7 @@ You may only want to use this parameter to associate an action to an OneNote fol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +237,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -229,7 +247,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPISuppressionSetting.md index 8148ff7a6..65a4948f5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWOPISuppressionSetting.md @@ -7,7 +7,7 @@ title: New-SPWOPISuppressionSetting schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWOPISuppressionSetting @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Disables Office Web Apps for the action, file name extension, or programmatic identifier that you've specified on the current SharePoint farm. - ## SYNTAX ``` @@ -24,16 +23,15 @@ New-SPWOPISuppressionSetting [-Action ] [-AssignmentCollection Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the action to suppress for a given extension or programmatic identifier (ProgId). For example, "view," "edit," and "embedview." For a full list of actions, run `Get-SPWOPIBinding`. @@ -52,8 +52,7 @@ For example, "view," "edit," and "embedview." For a full list of actions, run `G ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -70,8 +72,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extension to suppress. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. @@ -105,8 +111,7 @@ Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI applica ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the programmatic identifier (ProgId) for an application to suppress. Run `Get-SPWOPIBinding` to get the list of ProgIds that the WOPI application supports. @@ -123,8 +131,7 @@ Run `Get-SPWOPIBinding` to get the list of ProgIds that the WOPI application sup ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWeb.md index e5a3b79c5..2bf13188b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWeb.md @@ -7,7 +7,7 @@ title: New-SPWeb schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWeb @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new site in an existing site collection. - ## SYNTAX ``` @@ -33,10 +32,9 @@ If no template is specified, the site is created and the template can be provide For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPWeb https://somesite/subweb1 -Template "STS#0" ``` @@ -44,10 +42,12 @@ New-SPWeb https://somesite/subweb1 -Template "STS#0" This example creates a new subsite by using the Team Site template at the provided URL (https://somesite/subweb1). The Team Site template is a value referenced as the variable STS#0 for the Template parameter. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL where the new site is to be created. The URL must be inside an existing site collection. The URL must be a valid URL, in the form https://server_name/site1. @@ -55,8 +55,7 @@ The URL must be a valid URL, in the form https://server_name/site1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language template identifier for the new site. If no language is specified, the site is created with the same language that was specified when the product was installed. @@ -74,8 +76,7 @@ The type must be a valid language identifier (LCID). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web template for the new site. The template must already exist. If no template is specified, no template is applied and a template can be selected later. @@ -92,8 +96,7 @@ If no template is specified, no template is applied and a template can be select ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the title of the new site. If no title is specified, the default title is applied. The default title is configured for each template. @@ -110,8 +116,7 @@ The default title is configured for each template. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +126,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Describes the new site. If no description is specified, the entry is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -AddToQuickLaunch + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds this site to the Quick Launch. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +163,15 @@ Accept wildcard characters: False ``` ### -UniquePermissions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this site is to be created with unique permissions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -AddToTopNav + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds this site to the top-level navigation bar. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -UseParentTopNav + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the same top-level navigation bar as the parent site is to be used for this site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -213,8 +231,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +241,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -231,7 +251,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -241,6 +260,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -248,7 +270,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplication.md index aced35b35..60e973f39 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplication.md @@ -7,7 +7,7 @@ title: New-SPWebApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWebApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Web application within the local farm. - ## SYNTAX ``` @@ -36,29 +35,28 @@ The user specified by the DatabaseCredentials parameter must be a member of the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` New-SPWebApplication -Name "Contoso Internet Site" -Port 80 -HostHeader sharepoint.contoso.com -URL "http://www.contoso.com" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") ``` This example creates a new Web application by using an internal host header of sharepoint.contoso.com and a public URL of http://www.contoso.com. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` New-SPWebApplication -Name "Contoso Internet Site" -Port 443 -SecureSocketsLayer -HostHeader sharepoint.contoso.com -URL "https://www.contoso.com:443" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") ``` This example creates a new SSL enabled Web application by using an internal host header of sharepoint.contoso.com and a public URL of https://www.contoso.com. -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` $ap = New-SPAuthenticationProvider -New-SPWebApplication -Name "Contoso Internet Site" -URL "https://www.contoso.com" -Port 443 --ApplicationPool "ContosoAppPool" --ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") +New-SPWebApplication -Name "Contoso Internet Site" -URL "https://www.contoso.com" -Port 443 +-ApplicationPool "ContosoAppPool" +-ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") -AuthenticationProvider $ap -SecureSocketsLayer ``` @@ -67,6 +65,9 @@ Creates a Windows Claims web application at the URL https://www.contoso.com usin ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of an application pool to use; for example, SharePoint - 1213. If an application pool with the name provided does not exist, the ApplicationPoolAccount parameter must be provided and a new application pool will be created. If no value is specified, the default application pool will be used. @@ -74,8 +75,7 @@ If no value is specified, the default application pool will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,13 +85,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -101,13 +103,15 @@ Accept wildcard characters: False ``` ### -AdditionalClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a specific claim provider to the defined Web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,13 +121,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymousAccess + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows anonymous access to the Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +139,16 @@ Accept wildcard characters: False ``` ### -ApplicationPoolAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user account that this application pool will run as. Use the `Get-SPIisWebServicApplicationPool` cmdlet to use a system account. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +158,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -161,8 +172,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,14 +182,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Uses Kerberos or NTLM to specify the authentication method. If no value is specified, the default NTLM is applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +201,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication provider or providers that apply to a Web application. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +219,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -212,7 +229,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -222,13 +238,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Windows PowerShell Credential object for the database user account. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -238,6 +256,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the initial content database for the new Web application. The type must be a valid database name; for example, ContentDB1. @@ -246,8 +267,7 @@ If no value is specified, a value in the format WSS_Content_\ is auto-gen ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -257,6 +277,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server name. The type must be a valid database server name, in the form SQL1; where named instances are used, the format can appear as server\server. The default SQL server instance is used if a value is not provided. @@ -264,8 +287,7 @@ The default SQL server instance is used if a value is not provided. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +297,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid URL assigned to the Web application that must correlate to the alternate access mapping configuration, in the form server_name. When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. @@ -283,8 +308,7 @@ The Url parameter is used to specify the public URL.If no value is specified, th ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,6 +318,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the physical directory for the new Web application in the virtual directories folder. The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. If no value is specified, the value %wwwroot%\wss\VirtualDirectories\\\ is applied. @@ -301,8 +328,7 @@ If no value is specified, the value %wwwroot%\wss\VirtualDirectories\\\ Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the port on which this Web application can be accessed. This can be any valid port number. If no port is specified, a nonconflicting port number is automatically generated. @@ -321,8 +350,7 @@ If you specify a port number that has already been assigned, IIS does not start ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -332,6 +360,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables Secure Sockets Layer (SSL) encryption for this Web application. If you choose to use SSL, you must add the certificate on each server by using the IIS administration tools. Until this is done, the Web application will be inaccessible from this IIS Web site. @@ -339,8 +370,7 @@ Until this is done, the Web application will be inaccessible from this IIS Web s ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -350,6 +380,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the default proxy group for the farm is used. @@ -358,7 +391,6 @@ If this parameter is not specified, the default proxy group for the farm is used Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) Aliases: ProxyGroup -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -368,13 +400,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -384,13 +418,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign-in redirect URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -400,13 +436,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the load-balanced URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -416,13 +454,15 @@ Accept wildcard characters: False ``` ### -UserSettingsProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Provides access to external user settings provider. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -432,6 +472,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -439,7 +482,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationAppDomain.md index bade0ee18..a7a587353 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationAppDomain.md @@ -16,7 +16,6 @@ ms.reviewer: Creates an AppDomain entry. - ## SYNTAX ``` @@ -29,10 +28,9 @@ New-SPWebApplicationAppDomain [-AppDomain] -WebApplication Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the app domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -69,14 +68,14 @@ Accept wildcard characters: False ### -WebApplication -Specifies the GUID, URI, or name of the web application for which the app domain is being configured. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Specifies the GUID, URI, or name of the web application for which the app domain is being configured. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -87,6 +86,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -95,7 +96,6 @@ When the Global parameter is used, all objects are contained in the global store Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -106,13 +106,14 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,13 +124,14 @@ Accept wildcard characters: False ### -Port +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS port number to which the app domain will be assigned. If no value is specified, the same port used by the web application for the zone is applied. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -140,13 +142,14 @@ Accept wildcard characters: False ### -SecureSocketsLayer +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the app domain will use Secured Sockets Layer (SSL) security. If no value is specified, no SSL security will be used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -157,6 +160,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +169,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -175,6 +179,8 @@ Accept wildcard characters: False ### -Zone +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the security zone to which the app domain will be assigned. * Default @@ -193,7 +199,6 @@ If no value is specified, Default is applied. Type: SPUrlZone Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationExtension.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationExtension.md index c8cb22f1c..26608e05f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationExtension.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWebApplicationExtension.md @@ -7,7 +7,7 @@ title: New-SPWebApplicationExtension schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWebApplicationExtension @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new zone instance for the Web application. - ## SYNTAX ``` @@ -34,27 +33,27 @@ This is also known as extending a Web application and allows alternate permissio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPWebApplication http://sitename | New-SPWebApplicationExtension -Name "ExtranetSite" -SecureSocketsLayer -Zone "Extranet" -URL "https://extranet.sitename.com" ``` This example extends the given Web application at http://sitename to the Extranet zone for SSL use. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application to extend. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +63,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new IIS Web site in the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the five zones with which the internal URL of this new extension is to be associated. This zone cannot already be in use. @@ -88,8 +92,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -AdditionalClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a specific claim provider to the defined Web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymousAccess + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows anonymous access to the Web application zone. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -142,8 +152,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +162,15 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Uses Kerberos or NTLM to specify the authentication method. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +180,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the authentication provider(s) that applies to a Web apllication. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +198,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -192,7 +208,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid URL assigned to the Web application by that must correlate to the alternate access mapping configuration, in the form http://server_name. When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. @@ -210,8 +228,7 @@ The Url parameter is used to specify the public URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -221,14 +238,16 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the physical directory for the new Web site (in the virtual directories folder). The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application port. Can be any valid port number. @@ -248,8 +270,7 @@ If you specify a port number that is already assigned, IIS does not start the ne ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -259,15 +280,17 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables Secure Sockets Layer (SSL) encryption for this Web application. -If you use SSL, you must add the certificate on each server by using the IIS administration tools. +If you use SSL, you must add the certificate on each server by using the IIS administration tools. Until this is done, the Web application is inaccessible from this IIS Web site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -277,13 +300,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -293,13 +318,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign-in redirect URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -309,13 +336,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the load-balanced URL for the Web application zone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -325,6 +354,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -332,7 +364,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWordConversionServiceApplication.md index 1d96a8567..4ef3d9ed3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWordConversionServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWordConversionServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPWordConversionServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWordConversionServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new instance of a Word Automation Services application on the farm. - ## SYNTAX ``` @@ -30,20 +29,21 @@ The `New-SPWordConversionServiceApplication` cmdlet creates a new instance of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPWordConversionServiceApplication -Name 'Word Conversion Services' -ApplicationPool 'SharePoint Web Services Default' -DatabaseName 'Word' ``` This example creates a new Word Automation Services application named Word Conversion Services in an existing application pool named SharePoint Web Services Default. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new Word Automation Services application. The type must be a valid name of a Word Automation Services application; for example, WordSvcApp1. @@ -51,8 +51,7 @@ The type must be a valid name of a Word Automation Services application; for exa ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS-managed application pool in which this instance of Word Automation Services runs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -69,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +91,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials to use for connecting to the database for the Word Automation Services application. Use this parameter only if SQL Server Authentication is used to access the service application database. @@ -123,8 +131,7 @@ When the DatabaseCredential parameter is specified, the DatabaseName and Databas ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the new Word Automation Services application. The type must be a valid SQL database name; for example, MetadataDB1. @@ -141,8 +151,7 @@ The type must be a valid SQL database name; for example, MetadataDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the Word Automation Services database. The type must be a valid SQL database server host name; for example, SQLServerHost1. @@ -159,8 +171,7 @@ The type must be a valid SQL database server host name; for example, SQLServerHo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,13 +181,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the service application proxy is added to the farm's default proxy group for this Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -186,14 +199,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this service behaves uniquely on a partitioned set of site collections. This property cannot be changed after the application is provisioned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -210,7 +228,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplication.md index 5d01d9381..628e5f3e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplication.md @@ -7,7 +7,7 @@ title: New-SPWorkManagementServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWorkManagementServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Work Management Service application. - ## SYNTAX ``` @@ -32,25 +31,26 @@ Note: This functionality has been removed from SharePoint Server 2016, SharePoin ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPWorkManagementServiceApplication -Name 'Work Management Service Application' -ApplicationPool 'SharePoint Web Services Default' ``` This example creates a new Work Management Service Application using the Application Pool named SharePoint Web Services Default. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2013 + Specifies the name of an application pool to use; for example, SharePoint - 1213. If no value is specified, the default application pool is used. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -60,13 +60,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013 + Specifies the name of the Work Management Service application to be created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +88,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -94,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013 Required: False Position: Named @@ -112,13 +118,15 @@ Accept wildcard characters: False ``` ### -Proxy + +> Applicable: SharePoint Server 2013 + Specifies whether to add the Work Management Service application to the proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -128,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplicationProxy.md index 4aa63581f..eedc40638 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkManagementServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPWorkManagementServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWorkManagementServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new Work Management Service application proxy. - ## SYNTAX ``` @@ -33,7 +32,7 @@ Note: This functionality has been removed from SharePoint Server 2016, SharePoin ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $sa = New-SPWorkManagementServiceApplication -Name 'Work Management Service Application' -ApplicationPool 'SharePoint Web Services Default' New-SPWorkManagementServiceApplicationProxy -name 'Work Management Service Application Proxy' -ServiceApplication $sa @@ -41,10 +40,12 @@ New-SPWorkManagementServiceApplicationProxy -name 'Work Management Service Appli This example creates a new SPWorkManagementServiceApplicationProxy called Work Management Service Application Proxy mapped to the "Work Management Service Application" Service Application. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013 + Specifies the display name for the new Work Management Service application proxy. The name that you use must be a unique name of a Work Management Service application proxy in the farm. The maximum length is 128 characters. @@ -54,8 +55,7 @@ The value must be a name of a valid Work Management Service application proxy; f ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -65,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013 Required: False Position: Named @@ -104,13 +108,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013 + Specifies that the Work Management Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -120,6 +126,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013 + Specifies the local Work Management Service application that is associated with the new proxy. The value must be in one of the following forms: @@ -133,8 +142,7 @@ The value must be in one of the following forms: ```yaml Type: SPWorkManagementServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -144,16 +152,17 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server 2013 + Specifies the URI of a remote Work Management service application to connect to. To specify the Work Management service application that this proxy is connecting to, you must set only the URI parameter or only the ServiceApplication parameter. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -170,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkflowServiceApplicationProxy.md index f7e145870..ca20b297f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkflowServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/New-SPWorkflowServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: New-SPWorkflowServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # New-SPWorkflowServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a proxy to connect to Workflow Manager. - ## SYNTAX ``` @@ -28,20 +27,21 @@ Creates a proxy to connect to Workflow Manager. Note: Consider using the cmdlet `Register-SPWorkflowService` instead which binds a Workflow Manager farm and creates the Workflow Service Proxy. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` New-SPWorkflowServiceApplicationProxy ``` Creates a Workflow Service Application Proxy. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -76,14 +77,15 @@ Accept wildcard characters: False ``` ### -PartitionMode -Specifies that the service application restrict data by subscription. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that the service application restrict data by subscription. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +95,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -100,7 +105,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Pause-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Pause-SPProjectWebInstance.md index d542f5059..a0ccca874 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Pause-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Pause-SPProjectWebInstance.md @@ -7,7 +7,7 @@ title: Pause-SPProjectWebInstance schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Pause-SPProjectWebInstance @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server PSI or CSOM. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Switches the specified instance of Project Web App to read-only, preventing any For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} $instance = Get-SPProjectWebInstance -ServiceApplication $sa @@ -43,14 +41,16 @@ Pauses the Project Web Server Instance in the Project Web Application Service Ap ## PARAMETERS ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the instance of Project Web App to be switched to read-only mode. It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Publish-SPServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Publish-SPServiceApplication.md index 5fd0be3b9..0a42b0479 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Publish-SPServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Publish-SPServiceApplication.md @@ -7,7 +7,7 @@ title: Publish-SPServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Publish-SPServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Shares the specified local service application outside the farm. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Publish-SPServiceApplication` cmdlet publishes the local service applicatio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Publish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -Description "Connect to this TestServiceApplcation of you want to use FeatureA in your farm" -InfoLink https://testurl ``` @@ -42,10 +40,12 @@ This example publishes a service application to another farm. The service application GUID is unique to every farm. You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, `Grant-SPServiceApplication`. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application to share outside the farm. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Describes the service application to share outside the farm. If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -InfoLink + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the link to more information about the service application to share outside the farm. If no link is specified, no link is made available. @@ -128,8 +136,7 @@ The type must be a valid URL, in the form https://server_name/Site_Name/page_na ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Receive-SPServiceApplicationConnectionInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Receive-SPServiceApplicationConnectionInfo.md index 967ec1a68..565331fb9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Receive-SPServiceApplicationConnectionInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Receive-SPServiceApplicationConnectionInfo.md @@ -7,7 +7,7 @@ title: Receive-SPServiceApplicationConnectionInfo schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Receive-SPServiceApplicationConnectionInfo @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures this farm to receive service information from another farm. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Receive-SPServiceApplicationConnectionInfo` cmdlet retrieves the list of se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Receive-SPServiceApplicationConnectionInfo -FarmUrl https://FarmB/topology/topology.svc ``` @@ -40,10 +38,12 @@ This example retreives a list of service applications published by a given farm. The FarmURL parameter can be obtained by the `Get-SPTopologyServiceApplication` cmdlet. - ## PARAMETERS ### -FarmUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the farm from which to receive service application information. The type must be a valid URL, in the form https://site_name. @@ -51,8 +51,7 @@ The type must be a valid URL, in the form https://site_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a filter to use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPAppPrincipal.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPAppPrincipal.md index b55ed2f43..809e27ea6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPAppPrincipal.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPAppPrincipal.md @@ -7,7 +7,7 @@ title: Register-SPAppPrincipal schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Register-SPAppPrincipal @@ -25,13 +25,11 @@ Register-SPAppPrincipal -DisplayName -NameIdentifier -Site " Register-SPAppPrincipal -site $site.RootWeb -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -DisplayName "Contoso" @@ -39,17 +37,18 @@ Register-SPAppPrincipal -site $site.RootWeb -NameIdentifier "00000003-0000-0ff1- This example registers the app principal named Contoso. - ## PARAMETERS ### -DisplayName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the friendly name to use for the app principal that is being registered. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -NameIdentifier + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app principal's name identifier that needs to be added to the app management service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,13 +76,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill Site Description}} ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +108,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPWorkflowService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPWorkflowService.md index 78d29e579..0a45f7071 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPWorkflowService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Register-SPWorkflowService.md @@ -7,7 +7,7 @@ title: Register-SPWorkflowService schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Register-SPWorkflowService @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Registers a Workflow Manager farm with the SharePoint farm. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Register-SPWorkflowService [-AllowOAuthHttp] [-AssignmentCollection Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows connecting to Workflow Manager using HTTP rather than HTTPS. This is not recommended for security. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -54,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +78,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the registration, even if previously registered. Will overwrite the existing Scope. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +96,15 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies to use a SharePoint multi-tenancy features when registering Workflow Manager. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -108,13 +114,15 @@ Accept wildcard characters: False ``` ### -SPSite + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The Site Collection used as a reference to register Workflow Manager with the SharePoint farm. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -124,13 +132,15 @@ Accept wildcard characters: False ``` ### -ScopeName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the scope in Workflow Manager to use. if not specified, the default Scope will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +150,15 @@ Accept wildcard characters: False ``` ### -WorkflowHostUri + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URI on which the Workflow Manager is hosted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-DatabaseFromAvailabilityGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-DatabaseFromAvailabilityGroup.md index 64a69a998..32f0b1f11 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-DatabaseFromAvailabilityGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-DatabaseFromAvailabilityGroup.md @@ -7,7 +7,7 @@ title: Remove-DatabaseFromAvailabilityGroup schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-DatabaseFromAvailabilityGroup @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes one or more SharePoint databases from an availability group in SQL Server. - ## SYNTAX ### Default @@ -33,27 +32,27 @@ Remove-DatabaseFromAvailabilityGroup [-AGName] [-AssignmentCollection < ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [https://msdn.microsoft.com/library/dd878348(VS.85).aspx](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -Remove-DatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content +Remove-DatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content ``` This example removes the availability group named "MyAvailabilityGroup" from the WSS_Content database. - ## PARAMETERS ### -AGName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the availability group from which the databases are being removed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -70,8 +72,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,15 +82,17 @@ Accept wildcard characters: False ``` ### -DatabaseName -The name of the database to be removed from the availability group. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The name of the database to be removed from the availability group. NOTE: This parameter should not be used in conjunction with the ProcessAllDatabases parameter. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces a remove from the group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -KeepSecondaryData + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that copies of the databases on the replicas in the availability group will not be deleted. Otherwise, those database copies will be dropped. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -ProcessAllDatabases -Removes all databases from the current SharePoint farm into the availability group. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Removes all databases from the current SharePoint farm into the availability group. ```yaml Type: SwitchParameter Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchContentCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchContentCollection.md index 14ee85faa..62e5dc677 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchContentCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchContentCollection.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchContentCollection --- @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchContentCollection -Name newscollection -Force ``` This example removes the content collection named "newscollection" without asking the user to confirm the operation. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchContentCollection -Name newscollection -WhatIf ``` @@ -46,13 +46,15 @@ This example describes what would happen if you executed the Remove-FASTSearchCo ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the content collection to delete. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. @@ -73,7 +78,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings so the user is not asked to confirm the operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -106,7 +115,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCategory.md index 800a628fb..aa3f54d44 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCategory.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataCategory --- @@ -38,7 +38,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchMetadataCategory -name SharePoint ``` @@ -47,7 +47,7 @@ This example deletes the category named "SharePoint". Confirmation of the operation is requested. All crawled properties mapped to the "SharePoint" category are also removed. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$category = Get-FASTSearchMetadataCategory -name Office Remove-FASTSearchMetadataCategory -category $category -force @@ -59,13 +59,15 @@ Since Force is specified, confirmation of the operation is not required. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the category to delete. ```yaml Type: String Parameter Sets: Name Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 @@ -75,13 +77,15 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: FAST Server for SharePoint 2010 + A category object to be deleted. ```yaml Type: Category Parameter Sets: Category -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. @@ -102,7 +109,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -112,13 +118,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings, so that confirmation of the operation is not required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -128,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -135,7 +146,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCrawledPropertyMapping.md index d53f3b9a5..18daafa6d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCrawledPropertyMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataCrawledPropertyMapping.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataCrawledPropertyMapping --- @@ -34,7 +34,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` $title = Get-FASTSearchMetadataManagedProperty -name title $crawledproperties = $title.GetCrawledPropertyMappings() @@ -52,14 +52,16 @@ The last of the crawled properties (array index 4) has the mapping removed from ## PARAMETERS ### -CrawledProperty + +> Applicable: FAST Server for SharePoint 2010 + The crawled property which is having a mapping removed. The object can be retrieved by using Get-FASTSearchMetadataCrawledProperty, or by using the GetCrawledPropertyMappings() method call on a managed property object. ```yaml Type: CrawledProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -69,14 +71,16 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property object which is having a mapping removed. The object can be retrieved by using the Get-FASTSearchMetadataManagedPropertycmdlet. ```yaml Type: ManagedProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. If Confirm is false (-Confirm:$false), confirmation prompting is not used. @@ -96,7 +103,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -106,13 +112,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings, so that confirmation of the operation is not required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -122,6 +130,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -129,7 +140,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndex.md index d210c1960..6e147f3c8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndex.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataFullTextIndex --- @@ -37,7 +37,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchMetadataFullTextIndex -name secondarycontent ``` @@ -45,7 +45,7 @@ Remove-FASTSearchMetadataFullTextIndex -name secondarycontent This example removes the full text index named "secondarycontent" from the FAST Search Server 2010 for SharePoint system. The cmdlet asks for confirmation as long as neither the Force parameter is used or the $ConfirmPreference environment is set to a higher value than HIGH. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$index=Get-FASTSearchMetadataFullTextIndex -name secondarycontent Remove-FASTSearchMetadataFullTextIndex -FullTextIndex $index -force @@ -57,13 +57,15 @@ Since the Force parameter is specified, confirmation of the index removal is not ## PARAMETERS ### -FullTextIndex + +> Applicable: FAST Server for SharePoint 2010 + A full text index object representing the full text index to remove. ```yaml Type: FullTextIndex Parameter Sets: FullTextIndex -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the full text index to remove. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. If Confirm is false (-Confirm:$false), confirmation prompting is not used. @@ -99,7 +106,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -109,13 +115,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings, so that confirmation of the operation is not required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -125,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -132,7 +143,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndexMapping.md index 51024dacd..132cab8d9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndexMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataFullTextIndexMapping.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataFullTextIndexMapping --- @@ -31,7 +31,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` $fulltextindex = Get-FASTSearchMetadataFullTextIndex -Name content $managedproperty = Get-FASTSearchMetadataManagedProperty -Name CreatedBy @@ -45,13 +45,15 @@ Since the cmdlet takes an object of the mapping, the example first retrieves the ## PARAMETERS ### -Mapping + +> Applicable: FAST Server for SharePoint 2010 + An object representing the full text index mapping to be removed. ```yaml Type: FullTextIndexMapping Parameter Sets: (All) Aliases: FullTextIndexMapping, M -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataManagedProperty.md index 3bf159213..ecc251893 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataManagedProperty.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataManagedProperty --- @@ -37,7 +37,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchMetadataManagedProperty -Name title ``` @@ -45,7 +45,7 @@ Remove-FASTSearchMetadataManagedProperty -Name title This example removes the managed property named "title" from the system. It will ask for confirmation before going through with the removal unless Force is specified. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` $createdby = Get-FASTSearchMetadataManagedProperty -name CreatedBy Remove-FASTSearchMetadataManagedProperty -ManagedProperty $createdby -Force @@ -59,13 +59,15 @@ No confirmation is required, since the Force parameter is specified. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the managed property to remove. ```yaml Type: String Parameter Sets: Name Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 @@ -75,13 +77,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + An object that represents the managed property to remove. ```yaml Type: ManagedProperty Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. If Confirm is false (-Confirm:$false), confirmation prompting is not used. @@ -101,7 +108,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -111,13 +117,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings, so that confirmation of the operation is not required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -127,6 +135,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -134,7 +145,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataRankProfile.md index 19c596572..697e1dcb7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataRankProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchMetadataRankProfile.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchMetadataRankProfile --- @@ -40,14 +40,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchMetadataRankProfile -Name webcontent ``` This example removes the rank profile "webcontent". -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` $rankprofile = Get-FASTSearchMetadataRankProfile -Name newrankprofile Remove-FASTSearchMetadataRankProfile -Force -RankProfile $rankprofile @@ -60,13 +60,15 @@ No confirmation is required, since the Force parameter is specified. ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the rank profile to remove. ```yaml Type: String Parameter Sets: Name Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 @@ -76,13 +78,15 @@ Accept wildcard characters: False ``` ### -RankProfile + +> Applicable: FAST Server for SharePoint 2010 + An object representing the rank profile to remove. ```yaml Type: RankProfile Parameter Sets: RankProfile -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -92,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. @@ -103,7 +110,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -113,13 +119,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings, so that confirmation of the operation is not required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -129,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -136,7 +147,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchResource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchResource.md index b2fce0b0e..7ddedb531 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchResource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchResource.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchResource --- @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchResource dictionaries\spellcheck\check_en.aut ``` @@ -39,13 +39,15 @@ This example deletes the resource dictionaries\spellcheck\check_en.aut from the ## PARAMETERS ### -Path + +> Applicable: FAST Server for SharePoint 2010 + Partial URI within the resource store of the file which will be deleted. ```yaml Type: String Parameter Sets: (All) Aliases: ResourceURI -Applicable: FAST Server for SharePoint 2010 Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSearchSettingGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSearchSettingGroup.md index 6c994a7c9..bb04bb0fa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSearchSettingGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSearchSettingGroup.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchSearchSettingGroup --- @@ -28,21 +28,21 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSearchSettingGroup -Name marketinggroup ``` This example deletes the "marketinggroup" search setting group. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSearchSettingGroup -Name marketinggroup -Force ``` This example deletes the "marketinggroup" search setting group without being prompted to confirm the operation. -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSearchSettingGroup -Name marketinggroup -WhatIf ``` @@ -52,13 +52,15 @@ This example describes what would happen if you executed the Remove-FASTSearchSe ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the search setting group to delete. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -68,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated. @@ -79,7 +84,6 @@ In cases where Confirm is not specified, the cmdlet will prompt if the $ConfirmP Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -89,13 +93,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: FAST Server for SharePoint 2010 + Overrides any user prompting settings so the user is not asked to confirm the operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -112,7 +121,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityAliaser.md index 4ec4bfb83..40e76a4bc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityAliaser.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchSecurityAliaser --- @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSecurityAliaser -Identity xmlalias2 ``` @@ -37,7 +37,7 @@ Remove-FASTSearchSecurityAliaser -Identity xmlalias2 This example deletes an XML aliaser. A prompt is displayed to confirm the request. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSecurityAliaser -Identity xmlalias4 -Confirm:$False ``` @@ -47,13 +47,15 @@ This example deletes an XML aliaser without displaying a prompt. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the regular expression or XML aliaser to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -SecurityAliaserToRemove + +> Applicable: FAST Server for SharePoint 2010 + A SecurityXMLAliaser or SecurityRegexAliaser object whose identity is used as the aliaser identity to remove. ```yaml Type: SecurityAliaser Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 10000 @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated and you must confirm the remove request. @@ -89,7 +96,6 @@ For example: -confirm:$false Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -106,7 +115,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityUserStore.md index 9da553a96..9f9fd025c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-FASTSearchSecurityUserStore.md @@ -6,7 +6,7 @@ applicable: FAST Server for SharePoint 2010 schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: title: Remove-FASTSearchSecurityUserStore --- @@ -30,7 +30,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Remove-FASTSearchSecurityUserStore -Identity wn1 ``` @@ -38,7 +38,7 @@ Remove-FASTSearchSecurityUserStore -Identity wn1 This example deletes the "wn1" user store. A prompt is displayed to confirm the request. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityLotusNotesUserStore ln2 | remove-FASTSearchSecurityUserStore ``` @@ -49,13 +49,15 @@ A prompt is displayed to confirm the request. ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -SecurityUserStoreToRemove + +> Applicable: FAST Server for SharePoint 2010 + A MicrosoftUserStore, LotusNotesUserStore, or ClaimsUserStore instance whose identity is used to remove the user store. ```yaml Type: SecurityUserStore Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: FAST Server for SharePoint 2010 + Activates user prompting to confirm the operation. If set, prompting is activated and you must confirm the remove request. @@ -91,7 +98,6 @@ For example: -confirm:$false Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: FAST Server for SharePoint 2010 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters @@ -108,7 +117,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: FAST Server for SharePoint 2010 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAccessServicesDatabaseServer.md index 1e88d2305..72748404a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAccessServicesDatabaseServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAccessServicesDatabaseServer.md @@ -7,7 +7,7 @@ title: Remove-SPAccessServicesDatabaseServer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPAccessServicesDatabaseServer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a server configured to host Access Services databases. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Remove-SPAccessServicesDatabaseServer [-ServiceContext] Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -59,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -75,13 +77,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SQL Server. ```yaml Type: AccessServicesDatabaseServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +95,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the Access Services database server group containing the SQL Server object to remove. ```yaml Type: AccessServicesDatabaseServerGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -107,13 +113,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,13 +131,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -139,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -146,7 +159,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPActivityFeedItems.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPActivityFeedItems.md index 266e91275..22a2807fa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPActivityFeedItems.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPActivityFeedItems.md @@ -7,7 +7,7 @@ title: Remove-SPActivityFeedItems schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPActivityFeedItems @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes activity events from the published and consolidated tables. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Remove-SPActivityFeedItems [-AllItems ] [-AssignmentCollection Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to delete events.A value of "1" deletes all events. A value of "0", no events are deleted.The default value is 0 (zero). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +68,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -ID + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Limits events deleted to those which match the specified ActivityEventID. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -125,15 +132,17 @@ Accept wildcard characters: False ``` ### -SearchText -Limits events deleted to those which contain SearchText in the string. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Limits events deleted to those which contain SearchText in the string. Note that the SearchText will apply to *all* of the XML text saved in SQL representing this activity. The text seen in a browser window may be saved in a different representation in SQL. For example, a ">" feed symbol may be represented as ">" text in SQL, so the SearchText should reference ">" instead of ">". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -143,15 +152,17 @@ Accept wildcard characters: False ``` ### -SiteSubscription -Specifies the account under which this service should run. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -168,7 +182,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAlternateURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAlternateURL.md index 0aa53e1af..b28573677 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAlternateURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAlternateURL.md @@ -7,7 +7,7 @@ title: Remove-SPAlternateURL schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPAlternateURL @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Completely deletes the specified alternate URL. - ## SYNTAX ``` @@ -28,36 +27,35 @@ The `Remove-SPAlternateUrl` cmdlet completely deletes the alternate URL specifie For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Remove-SPAlternateURL -Identity http://sitename ``` This example deletes the http://sitename alternate URL from the farm. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Remove-SPAlternateURL ``` This example removes all extranet alternate URLs in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the alternate URL to delete. The identity can be either a valid URL, in the form https://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -89,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -106,6 +108,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppDeniedEndpoint.md index e26fa0f9c..574b5fa17 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppDeniedEndpoint.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppDeniedEndpoint.md @@ -7,7 +7,7 @@ title: Remove-SPAppDeniedEndpoint schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPAppDeniedEndpoint @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a relative URL endpoint of a server from the list of app-denied endpoints. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPAppDeniedEndpoint` cmdlet to remove a relative URL endpoint of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" ``` @@ -39,18 +37,19 @@ Remove-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" This example removes the "/_vti_bin/contoso/service.asmx" endpoint from the list of denied endpoints for apps. Apps will be able to access this endpoint because it is being removed from the app-denied endpoint list. - ## PARAMETERS ### -Endpoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a relative URL endpoint of a server that will be removed from the list of app-denied endpoints. Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppPrincipalPermission.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppPrincipalPermission.md index 33f879cf2..a290f77a2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppPrincipalPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPAppPrincipalPermission.md @@ -7,7 +7,7 @@ title: Remove-SPAppPrincipalPermission schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPAppPrincipalPermission @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the permissions on a specified app principal. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the `Remove-SPAppPrincipalPermission` cmdlet to remove the permissions on a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE------------ +### EXAMPLE ``` $clientID = "11111111-2222-3333-4444-555555555555" $site = Get-SPSite http://siteUrl @@ -44,17 +42,18 @@ Remove-AppPrincipalPermission -AppPrincipal $appPrincipal -Site $site.RootWeb -S This example removes the App Principal permission from the site collection scope. - ## PARAMETERS ### -AppPrincipal + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the AppPrincipal object to remove. ```yaml Type: SPAppPrincipal Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope to which to apply the principal permission. The value is any of the following scopes: @@ -77,8 +79,7 @@ The value is any of the following scopes: ```yaml Type: SPCmdletAppPrincipalPermissionScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,13 +89,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site (that is, SPWeb object) to remove. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -111,8 +117,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -DisableAppOnlyPolicy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Disables the app only policy. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPApplicationCredentialKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPApplicationCredentialKey.md index 79814cfee..06f9c1098 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPApplicationCredentialKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPApplicationCredentialKey.md @@ -7,7 +7,7 @@ title: Remove-SPApplicationCredentialKey schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPApplicationCredentialKey @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the application credential key from the local server. - ## SYNTAX ``` @@ -23,13 +22,12 @@ Remove-SPApplicationCredentialKey [-AssignmentCollection ] ``` - ## DESCRIPTION Use the **Remove-SPApplicationCredentialKey** cmdlet to remove the application credential key from the local server. The application credential key is used by certain features to encrypt and decrypt passwords. ## EXAMPLES -### EXAMPLE +### EXAMPLE ```powershell Remove-SPApplicationCredentialKey -Confirm:$false ``` @@ -38,6 +36,9 @@ This example removes the application credential key from the local server withou ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,7 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -58,13 +59,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -80,7 +87,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -92,5 +99,4 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPBusinessDataCatalogModel.md index b39485b7a..48bae895d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPBusinessDataCatalogModel.md @@ -7,7 +7,7 @@ title: Remove-SPBusinessDataCatalogModel schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPBusinessDataCatalogModel @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a Business Data Connectivity Model. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Remove-SPBusinessDataCatalogModel` cmdlet deletes a Business Data Connectiv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$modelFile = Get-SPBusinessDataCatalogMetadataObject -Name "ContosoModel" -BdcObjectType Model -ServiceContext http://contoso @@ -40,17 +38,18 @@ Remove-SPBusinessDataCatalogModel -Identity $modelFile This example removes the Business Data Connectivity Model file named ContosoModel. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object to remove. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPCentralAdministration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPCentralAdministration.md index 9343971c1..5a7ad58be 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPCentralAdministration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPCentralAdministration.md @@ -7,7 +7,7 @@ title: Remove-SPCentralAdministration schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPCentralAdministration @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the SharePoint Central Administration web site from the local server. - ## SYNTAX ``` @@ -26,19 +25,20 @@ Remove-SPCentralAdministration [-AssignmentCollection ] ## DESCRIPTION Removes the SharePoint Central Administration web site from the local server. - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPCentralAdministration ``` This example removes the Central Administration web site from the local server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -73,6 +74,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -80,7 +84,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimProvider.md index 28d37ecb2..5f2d04f25 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimProvider.md @@ -7,7 +7,7 @@ title: Remove-SPClaimProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPClaimProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Unregisters a claim provider. - ## SYNTAX ``` @@ -29,20 +28,21 @@ If the unregistered claim provider was assigned to a trusted identity token issu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove - SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" ``` This example removes a claim provider from the farm - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claim provider to unregister. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimTypeMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimTypeMapping.md index 970c2ae5e..97d15c366 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPClaimTypeMapping.md @@ -7,7 +7,7 @@ title: Remove-SPClaimTypeMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPClaimTypeMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a claim type mapping rule for a security token service (STS) identity provider. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPClaimTypeMapping` cmdlet deletes a claim type mapping rule from a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------- +### EXAMPLE ``` -Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" | Remove-SPClaimTypeMapping "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" +Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" | Remove-SPClaimTypeMapping "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" ``` This example removes the claim type mapping emailaddress from the LiveIDSTS identity provider. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claim mapping to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimTypeMapping object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the token issuer or a valid SPTrustedIdentityTokenIssuerPipeBind object. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -117,7 +125,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPConfigurationDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPConfigurationDatabase.md index 1a1c3b49a..4cd0561b9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPConfigurationDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPConfigurationDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPConfigurationDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Permanently removes a configuration database. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The configuration database must be already dismounted from any associated farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPConfigurationDatabase ``` This example permanently deletes a configuration database from a farm. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -72,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDatabase.md index 8c92a8099..279e5fe0b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPContentDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPContentDatabase @@ -29,17 +29,16 @@ This will remove the content database from SharePoint Products but not from SQL For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE--------------------- +### EXAMPLE ``` Remove-SPContentDatabase WSS_Content ``` This example deletes the content database named 'WSS_Content'. -### -----------------EXAMPLE--------------------- +### EXAMPLE ``` Remove-SPContentDatabase WSS_Content -Confirm:$false -Force ``` @@ -49,6 +48,9 @@ This example deletes the content database named 'WSS_Content' without asking any ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database to delete. The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -56,8 +58,7 @@ The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +78,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the force of a removal. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentJob.md index d2a3a0aa6..a27f0e1be 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentJob.md @@ -7,7 +7,7 @@ title: Remove-SPContentDeploymentJob schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPContentDeploymentJob @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a content deployment job. - ## SYNTAX ``` @@ -28,28 +27,28 @@ The `Remove-SPContentDeploymentJob` cmdlet removes a content deployment job. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPContentDeploymentJob -Identity "DeployJob1" ``` This example removes a deployment job named DeployJob1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment job to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentPath.md index 702633ee5..7c7eca31c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPContentDeploymentPath.md @@ -7,7 +7,7 @@ title: Remove-SPContentDeploymentPath schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPContentDeploymentPath @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a content deployment path. - ## SYNTAX ``` @@ -28,28 +27,28 @@ The `Remove-SPContentDeploymentPath` cmdlet removes a content deployment path. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPContentDeploymentPath -Path1 ``` This example removes a content path named Path1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment path to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDeletedSite.md index b1fd9ae91..ba2e74072 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDeletedSite.md @@ -7,7 +7,7 @@ title: Remove-SPDeletedSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPDeletedSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a deleted site collection. - ## SYNTAX ``` @@ -36,28 +35,28 @@ For additional information about a server-relative URL or understanding general For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c ``` This example permanently removes a specific deleted site collection by using a site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the deleted site collection to permanently delete. The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -113,8 +119,7 @@ The type must be a valid database name in the form SPContentDB01 or a valid GUID ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -131,8 +139,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDiagnosticsPerformanceCounter.md index 0451e7b8b..e6777caac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDiagnosticsPerformanceCounter.md @@ -7,7 +7,7 @@ title: Remove-SPDiagnosticsPerformanceCounter schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPDiagnosticsPerformanceCounter @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an instance of a performance counter. - ## SYNTAX ``` @@ -34,36 +33,35 @@ There is no user interface. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Remove-SPDiagnosticsPerformanceCounter -category ASP.NET ``` This example removes all the counters in the category ASP.NET on front end Web servers. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Remove-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" ``` This example removes the counters in the category ASP.NET that have requests queued on front end Web servers. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Remove-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver ``` This example removes the counters of the _Total instance, with the counter % Processor Time in the category Processor on database servers. - ## PARAMETERS ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category of performance counters to remove. The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. @@ -71,8 +69,7 @@ The type must be a valid name of a category of performance counters; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -82,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,6 +122,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of counter to remove. If this parameter is not specified, this cmdlet removes all performance counters of the specified category. @@ -130,8 +134,7 @@ Disk Queue Length, and % Processor Time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +144,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the specified performance counters that are collected on the database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +162,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the instance name of the performance counter to remove. If this parameter is not specified, this cmdlet removes all instances of the specified performance counter. @@ -165,8 +173,7 @@ The type must be a valid name of a performance counter instance; for example Tot ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,13 +183,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes performance counters that are collected on the front end Web servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -192,6 +201,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -199,7 +211,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDistributedCacheServiceInstance.md index 061e88aaf..921529935 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPDistributedCacheServiceInstance.md @@ -7,7 +7,7 @@ title: Remove-SPDistributedCacheServiceInstance schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPDistributedCacheServiceInstance @@ -26,10 +26,9 @@ Use the Remove-SPDistributedCacheServiceInstance cmdlet to remove an instance of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPDistributedCacheServiceInstance ``` @@ -39,16 +38,17 @@ This example removes an instance of a distributed cache. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEduClassMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEduClassMember.md index d3feb0a82..4878c0bae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEduClassMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEduClassMember.md @@ -7,7 +7,7 @@ title: Remove-SPEduClassMember schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEduClassMember @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Do not use - ## SYNTAX ``` @@ -26,10 +25,9 @@ Remove-SPEduClassMember [-AssignmentCollection ] -ClassI ## DESCRIPTION Do not use - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Do not use ``` @@ -37,13 +35,15 @@ Do not use ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -53,13 +53,15 @@ Accept wildcard characters: False ``` ### -ClassId + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -69,13 +71,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -UserAlias + +> Applicable: SharePoint Server 2013 + Do not use ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchComponent.md index 42fd605a3..e01cb2a3f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchComponent.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchComponent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchComponent @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the specified search component from the given search topology. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet removes the specified search component from an inactive search topol For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e @@ -41,17 +39,18 @@ Remove-SPEnterpriseSearchComponent -SearchTopology $topology -Identity c1642176- This example removes the search component with identity c1642176-b9ae-4096-834c-080da5fba90e from the search topology with identity 10fa59cb-4b32-4fe6-8f8d-065388df201e from the default search application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity for a search component ```yaml Type: SearchComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,14 +60,15 @@ Accept wildcard characters: False ``` ### -SearchTopology -Specifies the search topology from which to retrieve the search component/search components. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search topology from which to retrieve the search component/search components. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,14 +121,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the search topology and search component/search components. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service application that contains the search topology and search component/search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md index d83866c8c..4bc13c8e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchContentEnrichmentConfiguration schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchContentEnrichmentConfiguration @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the current content enrichment configuration from the search service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ This cmdlet removes the current content enrichment configuration from the Search For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa @@ -39,17 +37,18 @@ Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa This example removes the content enrichment configuration from the default search service application. - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SearchServiceApplication that contains content enrichment configuration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,14 +58,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlContentSource.md index 761344362..9184efc74 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlContentSource.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlContentSource schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlContentSource @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a specified crawl content source from a search application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Remove-SPEnterpriseSearchCrawlContentSource` cmdlet deletes a specified cra For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $topo = Get-SPEnterpriseSearchCrawlTopology -SearchApplication $searchapp @@ -45,10 +43,12 @@ $newtopo | Set-SPEnterpriseSearchCrawlTopology -Active This example creates a new, inactive, crawl topology, removes a crawl component from it and activates the new crawl topology. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The crawl content source to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. @@ -56,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +76,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -109,8 +115,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlCustomConnector.md index 8130db929..5c4c525b7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlCustomConnector.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlCustomConnector schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlCustomConnector @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a CustomConnector object. - ## SYNTAX ``` @@ -29,28 +28,28 @@ The `Get-SPEnterpriseSearchCrawlCustomConnector` selects the custom connector or For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication MySearchServiceApp" - Identity "dctm://" | Remove-SPEnterpriseSearchCrawlCustomConnector ``` This example removes a custom connector for the dctm:// protocol from the MySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the CustomConnector object to remove. The Identity parameter must be an instance of a valid CustomConnector object. ```yaml Type: SPCustomConnectorPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplicationobject. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlDatabase.md index f6a16d491..636332d37 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a crawl database. - ## SYNTAX ``` @@ -30,10 +29,9 @@ A crawl database stores crawl history for a search service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPEnterpriseSearchCrawlDatabase -Identity CrawlDB-0 -SearchApplication mySearchServiceApp @@ -41,10 +39,12 @@ Remove-SPEnterpriseSearchCrawlDatabase -Identity CrawlDB-0 This example removes the CrawlDB-0 crawl database from the mySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl database to delete. A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. @@ -52,8 +52,7 @@ A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 1 ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl database collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -109,8 +115,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlExtension.md index 58362b703..fbf180ebf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlExtension.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlExtension schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlExtension @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a file name extension from the list of files that can be crawled. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Remove-SPEnterpriseSearchCrawlExtension` cmdlet prevents files with this ex For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $searchapp | Get-SPEnterpriseSearchCrawlExtension "pdf" | Remove-SPEnterpriseSearchCrawlExtension @@ -40,10 +38,12 @@ $searchapp | Get-SPEnterpriseSearchCrawlExtension "pdf" | Remove-SPEnterpriseSea This example removes the PDF IFilter and removes the pdf file extension from the list of file types to include in the content index. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The file name extension to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ExtensionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -69,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the extension collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -104,8 +110,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlLogReadPermission.md index 4b09f9a82..96ffaf648 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlLogReadPermission.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlLogReadPermission schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlLogReadPermission @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes permission to view crawl log information. - ## SYNTAX ``` @@ -32,10 +31,9 @@ The administrator can choose to restrict this removal to a particular tenant. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" @@ -45,10 +43,12 @@ Remove-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -U This example removes user1 and user2 from the list of users referenced by $crawlLogPermission. $crawlLogPermission is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -56,8 +56,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -74,7 +76,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl log permissions list from which to remove the user(s). ```yaml Type: CrawlLogReadPermissionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +103,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl log. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +122,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the tenant for which the user permissions shall be removed. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -UserNames + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user names that shall no longer have permission to view the crawl log information. Separate names with semi-colons. @@ -144,8 +154,7 @@ When adding several user names, separate names with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlMapping.md index f9b880645..2ef2870e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlMapping.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a crawl mapping. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Remove-SPEnterpriseSearchCrawlMapping` cmdlet deletes a crawl mapping from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchapp = Get-SPEnterpriseSearchServiceApplication "Sample Search Service Application" $mappingtodelete = Get-SPEnterpriseSearchCrawlContentSource -Identity "somemapping" @@ -41,10 +39,12 @@ mappingtodelete | Remove-SPEnterpriseSearchCrawlMapping This example removes a crawl mapping from a search application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The crawl mapping to delete. A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid CrawlMapping object. @@ -52,8 +52,7 @@ A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in ```yaml Type: CrawlMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -70,8 +72,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -105,8 +111,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlRule.md index d6053fa2d..4d7ec4239 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchCrawlRule.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchCrawlRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchCrawlRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a crawl rule. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Remove-SPEnterpriseSearchCrawlRule` cmdlet deletes a crawl rule that is use For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp Remove-SPEnterpriseSearchCrawlRule -Identity https://mySPSite -SearchApplication $searchApp @@ -40,10 +38,12 @@ Remove-SPEnterpriseSearchCrawlRule -Identity https://mySPSite -SearchApplication This example removes a crawl rule pertaining to the path https://mySPSite from the mySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The crawl rule to delete. A valid crawl rule URL, such as https://server_name, or an instance of a valid CrawlRule object. @@ -51,8 +51,7 @@ A valid crawl rule URL, such as https://server_name, or an instance of a valid C ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -69,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The search application that contains the crawl rule collection. A valid search application name, such as SearchApp1, or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SearchServiceApplication object. @@ -104,8 +110,7 @@ A valid search application name, such as SearchApp1, or a valid GUID, such as 12 ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchFileFormat.md index 95dfc2952..13b9c6d68 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchFileFormat.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchFileFormat schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchFileFormat @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes support for parsing a file format. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Afterwards the search parsing system will stop parsing the file format. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity foo @@ -42,18 +40,18 @@ Remove-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity foo This example uses the `Remove-SPEnterpriseSearchFileFormat` cmdlet to remove the file format with the belonging file name extension foo in the search service application referenced by $ssa. - ## PARAMETERS ### -Identity -Specifies the identification of the format to be removed. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the identification of the format to be removed. ```yaml Type: DocumentParserFileFormatPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,14 +61,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the file format. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service application that contains the file format. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLanguageResourcePhrase.md index 66217c33b..e50357e59 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLanguageResourcePhrase.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchLanguageResourcePhrase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchLanguageResourcePhrase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a language resource phrase from a shared search application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The `Remove-SPEnterpriseSearchLanguageResourcePhrase` cmdlet deletes one or more For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $obsoletephrase = Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $searchapp -Language en-us -Type QuerySuggestionBlockList -Identity secret @@ -42,20 +40,20 @@ $obsoletephrase | Remove-SPEnterpriseSearchLanguageResourcePhrase -SearchApplica This example removes a language resource item on the QuerySuggestionBlockList for the en-us language. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,15 +63,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -83,16 +82,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The language resource phrase to delete. The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - ```yaml Type: LanguageResourcePhrasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,16 +102,17 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deletes phrases of the specified language only. The type must be a valid name of a language; for example, en_us. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,17 +122,18 @@ Accept wildcard characters: False ``` ### -Mapping + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +143,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -153,12 +158,10 @@ The owner must be one of the following valid levels: - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -168,16 +171,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +191,15 @@ Accept wildcard characters: False ``` ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +209,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Constrains to delete phrases of specified type. The type must be one of the following valid types of phrases: @@ -216,12 +224,10 @@ The type must be one of the following valid types of phrases: - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -231,15 +237,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLinksDatabase.md index 40537d80d..cc957350c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchLinksDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchLinksDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchLinksDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a links database. - ## SYNTAX ``` @@ -30,10 +29,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $linksDatabase = $ssa | Get-SPEnterpriseSearchLinksDatabase Links2 @@ -43,18 +41,19 @@ Remove-SPEnterpriseSearchLinksDatabase -Identity $linksDatabase This example removes the links database referenced by $linksDatabase. $linksDatabase is the identity of the links database Links2 on the search service application referenced by $ssa. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the links database to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,14 +102,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataCategory.md index 1195b57a3..c9795578e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataCategory.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchMetadataCategory schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchMetadataCategory @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a crawled property category. - ## SYNTAX ``` @@ -30,21 +29,22 @@ You should use this cmdlet after a crawl to delete unused or unwanted categories For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -$searchapp = Get-SPEnterpriseSearchServiceApplication +$searchapp = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchMetadataCategory -Identity MyCategory -SearchApplication $searchapp ``` This example removes the metadata category named MyCategory for the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata category to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. @@ -54,8 +54,7 @@ Note that if only a name for a category is specified, a SearchApplication must a ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the enterprise search metadata property schema. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -111,8 +117,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataManagedProperty.md index 66b6f9272..0ca879e87 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataManagedProperty.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchMetadataManagedProperty schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchMetadataManagedProperty @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a metadata managed property. - ## SYNTAX ``` @@ -30,22 +29,23 @@ This cmdlet deletes a specified managed property from the managed property colle For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` -$searchapp = Get-SPEnterpriseSearchServiceApplication -$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity AboutMeUpdate +$searchapp = Get-SPEnterpriseSearchServiceApplication +$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity AboutMeUpdate Remove-SPEnterpriseSearchMetadataManagedProperty -Identity $mp ``` This example removes the managed property AboutMeUpdate from the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to delete. The type must be a valid name of a managed property, for example ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -55,8 +55,7 @@ Note that if only a name of a managed property is specified, a SearchApplication ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -73,8 +75,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -108,8 +114,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -126,8 +134,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -144,8 +154,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataMapping.md index 21bfd4df5..c5b47c494 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchMetadataMapping.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchMetadataMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchMetadataMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a metadata mapping from a managed property. - ## SYNTAX ``` @@ -30,14 +29,13 @@ A metadata mapping is the mapping between a managed property and one or more cra For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $searchapp = Get-SPEnterpriseSearchServiceApplication -$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People -$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1 +$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People +$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1 $mycp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name "MyCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity UserName New-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $mp -CrawledProperty $mycp @@ -48,10 +46,12 @@ Remove-SPEnterpriseSearchMetadataMapping -Identity $map -confirm:$false This example removes an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `Set-SPEnterpriseSearchMetadataMapping`) for the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata mapping to delete. The type must be a valid URL, in the form https://server_name, or an instance of a valid Mapping object. @@ -59,8 +59,7 @@ The type must be a valid URL, in the form https://server_name, or an instance of ```yaml Type: MappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,14 +69,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -111,8 +117,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryAuthority.md index b5ca82f27..2dc80cbcd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes an authoritative page. - ## SYNTAX ``` @@ -27,20 +26,21 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPEnterpriseSearchQueryAuthority -Identity https://contoso.com -SearchApplication MySSA ``` This example removes the query authority URL https://contoso.com from the search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query authority page to delete. The type must be a valid URL, in the form https://server_name; or an instance a valid AuthorityPage object. @@ -48,8 +48,7 @@ The type must be a valid URL, in the form https://server_name; or an instance a ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the authoritative page collection to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -121,8 +129,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryDemoted.md index 98505474c..59c65a3ec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryDemoted.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchQueryDemoted schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchQueryDemoted @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a demoted site rule. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Query demoted sites are de-emphasized in relevance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity https://somesite.com -SearchApplication MySSA $demotedRule | Remove-SPEnterpriseSearchQueryDemoted @@ -41,10 +39,12 @@ $demotedRule | Remove-SPEnterpriseSearchQueryDemoted This example obtains a reference to a site demotion rule for the URL https://somesite.com and removes it. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the demoted site rule to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid Demoted object. @@ -52,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: DemotedPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,13 +62,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -86,8 +90,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the demoted site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -121,8 +129,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryKeyword.md index b14286f55..6c64f21f3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryKeyword.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchQueryKeyword schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchQueryKeyword @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a query keyword. - ## SYNTAX ``` @@ -30,20 +29,21 @@ You cannot use this cmdlet after a site collection is upgraded to SharePoint Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Remove-SPEnterpriseSearchQueryKeyword -Site https://myserver/sites/engineering ``` This example removes the Engineering keyword from the site collection at https://myserver/sites/engineering. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the keyword term to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to delete keywords from the specified site collection of results. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -69,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScope.md index ce0af301e..cd6440a32 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScope.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchQueryScope schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchQueryScope @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a query scope. - ## SYNTAX ``` @@ -37,10 +36,9 @@ A query scope represents a query results scope used by all shared search applica For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPenterpriseSearchServiceApplication -Identity MySSA Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Remove-SPEnterpriseSearchQueryScope @@ -48,10 +46,12 @@ Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | R This example removes a scope named MustCrawl from a search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query scope to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -59,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -77,8 +79,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope collection. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -112,8 +118,7 @@ The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to delete scopes of the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -131,7 +139,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScopeRule.md index ddee403ce..c38fc8e84 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchQueryScopeRule.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchQueryScopeRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchQueryScopeRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes query results scope rules. - ## SYNTAX ``` @@ -36,10 +35,9 @@ The `Remove-SPEnterpriseSearchQueryScopeRule` cmdlet deletes one or more shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "MySSA" $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -48,10 +46,12 @@ Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url https://criticalSite | R This example removes a scope rule for the URL https://criticalSite from a search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope rule to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. @@ -59,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to delete query scope rules for the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -78,7 +80,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -95,8 +99,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to delete multiple rules for a specified scope. The type must be a valid string that identifies the scope; for example, Scope1. @@ -131,7 +139,6 @@ The type must be a valid string that identifies the scope; for example, Scope1. Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -148,8 +158,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -166,7 +178,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchRankingModel.md index 1a361d8de..784ff55f5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchRankingModel.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchRankingModel schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchRankingModel @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a ranking model. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet deletes a specified ranking model. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` C:\PS>$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -41,8 +39,7 @@ Remove-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e0 This example removes the ranking model for the search service application with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $owner = Get-SPEnterpriseSearchOwner -Level ssa $MyRanking = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" | Get-SPEnterpriseSearchRankingModel -Owner $owner @@ -51,10 +48,12 @@ Remove-SPEnterpriseSearchRankingModel -Identity $MyRanking -Owner $owner This example removes the ranking model object MyRanking from the search service application Search Service Application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ranking model to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. @@ -62,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +71,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -81,7 +82,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -91,14 +91,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -125,6 +129,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the ranking model. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -132,8 +139,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultItemType.md index e4c8eda69..5ed43d603 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultItemType.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a result item type for a search object owner. - ## SYNTAX ``` @@ -26,7 +25,7 @@ Remove-SPEnterpriseSearchResultItemType [-Identity] -Ow The `Remove-SPEnterpriseSearchResultItemType` cmdlet removes a user-created result item type, given a result type identity and a search owner. You cannot use this cmdlet to remove the built-in result item types that are included with SharePoint products. -Result item types enable you to change the look of search results based on the type of result. +Result item types enable you to change the look of search results based on the type of result. You start by defining a collection of rules, which will be evaluated against the properties of results. Then you define the display template to use for rendering that type of result. Once you have created the result item type, results matching the rules of the result item type will display using the specified display template. @@ -43,10 +42,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $web = Get-SPWeb "UrlOfTheSite" $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web @@ -63,14 +61,16 @@ Next, the example removes the result item type referenced by $resultType for the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -80,13 +80,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -96,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -103,8 +108,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -131,14 +137,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +156,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultSource.md index b4589fd81..60b1dd14c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchResultSource.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchResultSource schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchResultSource @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a result source. - ## SYNTAX ``` @@ -27,13 +26,12 @@ Remove-SPEnterpriseSearchResultSource [-Identity] -Owner ## DESCRIPTION This cmdlet deletes a specified result source. This cmdlet supports the same delete operations as are supported through the "Manage Result Sources" page in Central Administration. -The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true). +The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true). For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -42,8 +40,7 @@ Remove-SPEnterpriseSearchResultSource -Identity "Custom SharePoint Result Source This example deletes the search service application level result source with the name "Custom SharePoint Result Source". - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -52,8 +49,7 @@ Remove-SPEnterpriseSearchResultSource -Identity 12345678-90ab-cdef-1234-567890bc This example deletes the search service application level result source with the id 12345678-90ab-cdef-1234-567890bcdefgh. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -63,20 +59,20 @@ Remove-SPEnterpriseSearchResultSource -Identity $resultSource -SearchApplication This example deletes the search service application level result source with the name "Custom SharePoint Result Source", by specifying a Source instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result source to delete. The result source cannot be a built in source. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,14 +82,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -103,15 +100,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,16 +119,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -157,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -164,7 +168,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSecurityTrimmer.md index 8242a20b9..3dd0416f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSecurityTrimmer.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchSecurityTrimmer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchSecurityTrimmer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a custom security trimmer. - ## SYNTAX ``` @@ -30,20 +29,21 @@ A custom security trimmer trims search results before the results are returned t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication MySSA | Remove-SPEnterpriseSearchSecurityTrimmer ``` This example removes the security trimmer registered in the search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the security trimmer to delete. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. @@ -51,8 +51,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SecurityTrimmerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the security trimmer. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -69,8 +71,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplication.md index a331cbbe5..f00d6055d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplication.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a search service application. - ## SYNTAX ``` @@ -28,20 +27,21 @@ This cmdlet deletes a specified SearchServiceApplication from a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPEnterpriseSearchServiceApplication -Identity MySSA ``` This example removes the search service application named MySSA from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to delete. A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -49,8 +49,7 @@ A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid sear ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that all search databases and index files associated with the search service application to be deleted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationProxy.md index eae8c4765..b72e6f45d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a search service application proxy. - ## SYNTAX ``` @@ -28,20 +27,21 @@ This cmdlet deletes the specified search service application proxy from a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPEnterpriseSearchServiceApplicationProxy -Identity SearchProxy ``` This example removes a search service application proxy named SearchProxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application proxy to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, ServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md index 18f216003..9c19fb7ef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchServiceApplicationSiteSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchServiceApplicationSiteSettings @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Cleans up search settings for a particular site collection, subscription, or search application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the `Remove-SPEnterpriseSearchServiceApplicationSiteSettings` cmdlet to remo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $app = Get-SPEnterpriseSearchServiceApplication $GC = Start-SPAssignment @@ -44,18 +42,19 @@ Stop-SPAssignment $GC This example removes the search settings for the site collection referenced by $s in the search application referenced by $app. $s is the site collection with URL "UrlOfSiteCollection" and $s.ID.ToString() is the string representation of the site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection to remove search settings from. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SiteSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,14 +64,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,14 +83,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,14 +121,16 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the tenant from which to remove search settings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSiteHitRule.md index 1dfe2f042..aac9ab529 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchSiteHitRule.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchSiteHitRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchSiteHitRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a site hit rule. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPEnterpriseSearchSiteHitRule` cmdlet deletes the site hit rule that For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------- +### EXAMPLE ``` Remove-SPEnterpriseSearchSiteHitRule -Identity myHost ``` This example removes a site hit rule for the myHost host. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The rule that is used for the specified site. The type must be a valid site hit rule host or an instance of a valid SiteHitRule object. @@ -50,8 +50,7 @@ The type must be a valid site hit rule host or an instance of a valid SiteHitRul ```yaml Type: SiteHitRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -68,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service in the farm that hosts the crawl. The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet is used. @@ -103,8 +109,7 @@ The type must be an instance of a valid SearchService object; otherwise, the loc ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantConfiguration.md index 4367583e1..02a1d89da 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes all tenant specific search settings. - ## SYNTAX ``` @@ -29,10 +28,9 @@ When moving a tenant, copy the tenant configuration from the source to the desti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000-0000-0000-000000000001" -SearchApplication $ssa @@ -40,10 +38,12 @@ Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000- This example uses Remove-SPEnterpriseSearchTenantConfiguration to remove all tenant specific settings from the search service application referenced by $ssa. - ## PARAMETERS ### -SiteSubscriptionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription of the tenant. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -51,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: Guid Parameter Sets: (All) Aliases: Identity -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -61,14 +60,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application that contains the tenant configuration. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -85,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantSchema.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantSchema.md index a055f817c..41f11e068 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantSchema.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTenantSchema.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchTenantSchema schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchTenantSchema @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a defined search schema. - ## SYNTAX ``` @@ -26,15 +25,14 @@ Remove-SPEnterpriseSearchTenantSchema [-Identity] ``` ## DESCRIPTION -This cmdlet removes a search schema. +This cmdlet removes a search schema. Use this cmdlet to remove an unused or unwanted search schema. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication [Guid]$guid = "909b84cb-90f2-4a1b-8df4-22547a9b2227" @@ -43,10 +41,12 @@ Remove-SPEnterpriseSearchTenantSchema -Identity $guid -SearchApplication $ssa This example removes the search schema for the tenant with GUID 909b84cb-90f2-4a1b-8df4-22547a9b2227. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the tenant of the search schema to be removed. The type must be a valid GUID, in string form, that identifies the tenant in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -56,8 +56,7 @@ The tenant GUID can be found in the Search Service Application database, in the ```yaml Type: TenantSchemaPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +76,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the enterprise search schema to be removed. The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -109,8 +115,7 @@ The type must be a valid search application name (for example, SearchApp1), or a ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the search schema to be removed is within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -127,8 +135,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTopology.md index b32d49407..133747dc1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPEnterpriseSearchTopology.md @@ -7,7 +7,7 @@ title: Remove-SPEnterpriseSearchTopology schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPEnterpriseSearchTopology @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an inactive search topology from a search service application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet removes the given inactive search topology from the search service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 4b32-4fe6-8f8d-065388df201e @@ -41,8 +39,7 @@ Remove-SPEnterpriseSearchTopology -Identity $topology This example removes a search topology with the identity 4b32-4fe6-8f8d-065388df201e. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchTopology -Identity $topo -SearchApplication $ssa @@ -50,17 +47,18 @@ Remove-SPEnterpriseSearchTopology -Identity $topo -SearchApplication $ssa This example removes the search topology referenced by $topo in the search service application referenced by $ssa. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology to retrieve. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -77,8 +78,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,6 +107,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which the search topology belongs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -112,8 +117,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBIServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBIServer.md index 15ca0349e..54e1ff861 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBIServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBIServer.md @@ -7,7 +7,7 @@ title: Remove-SPExcelBIServer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelBIServer @@ -16,7 +16,6 @@ ms.reviewer: Removes an instance of Analysis Services. - ## SYNTAX ``` @@ -31,11 +30,9 @@ Excel Services. - - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Remove-SPExcelBIServer -ExcelServiceApplication "MyExcel" @@ -44,10 +41,12 @@ Remove-SPExcelBIServer -ExcelServiceApplication "MyExcel" This example removes the instance of the anaylsis services that uses the Excel Service Application named, "MyExcel". - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -55,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -66,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -82,12 +82,14 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -97,13 +99,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the ExcelServiceApplication identity. ```yaml Type: SPExcelBIServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 0 @@ -113,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -120,7 +127,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBlockedFileType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBlockedFileType.md index a59072d96..4f297711a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBlockedFileType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelBlockedFileType.md @@ -7,7 +7,7 @@ title: Remove-SPExcelBlockedFileType schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelBlockedFileType @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an entry from the list of file types that are prevented from loading on Excel Services Application. - ## SYNTAX ``` @@ -25,15 +24,14 @@ Remove-SPExcelBlockedFileType [-Identity] ``` ## DESCRIPTION -The `Remove-SPExcelBlockedExcelFileType` cmdlet removes an entry from the list of file types that are prevented from loading on an Excel Services Application Web service application. +The `Remove-SPExcelBlockedExcelFileType` cmdlet removes an entry from the list of file types that are prevented from loading on an Excel Services Application Web service application. Excel Services Application does not load any file types that correspond to a file type that is on this list. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Remove-SPExcelBlockedExcelFileType -FileType XLSX ``` @@ -42,10 +40,12 @@ This example removes the .xlsx file name extensions from the list of file types After the .xlsx file name extension is removed from the list, these extensions are allowed to load in Excel Services Application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the file type to remove from the list of blocked file types. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; one of the following file types: XLSX, XLSB, XLSM; or an instance of a valid SPExcelBlockedFileType object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelBlockedFileTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPBlockedExcelFileType list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -71,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataConnectionLibrary.md index de0d8e5cd..e6ee30950 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataConnectionLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataConnectionLibrary.md @@ -7,7 +7,7 @@ title: Remove-SPExcelDataConnectionLibrary schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelDataConnectionLibrary @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a data connection library from Excel Services Application. - ## SYNTAX ``` @@ -25,15 +24,14 @@ Remove-SPExcelDataConnectionLibrary [-Identity] ``` ## DESCRIPTION -The `Remove-SPExcelDataConnectionLibrary` cmdlet removes a library from the Excel Services Application trusted data connection libraries list. +The `Remove-SPExcelDataConnectionLibrary` cmdlet removes a library from the Excel Services Application trusted data connection libraries list. Excel Services Application loads data connection files only if they are stored in a data connection library that is on the trusted data connection libraries list. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Get-SPExcelServiceApplication | Get-SPExcelDataConnectionLibrary | Remove-SPExcelDataConnectionLibrary ``` @@ -43,10 +41,12 @@ This example removes all data connection libraries from all Excel Services Appli Connection files are no longer loaded from any libraries. Workbooks that depend on any connection files might not refresh data. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the data connection library to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form https://server_name; or an instance of a valid SPExcelDCL object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelDCLPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelDataConnectionLibrary list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -72,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +98,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataProvider.md index f5a594c71..92eb24d19 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelDataProvider.md @@ -7,7 +7,7 @@ title: Remove-SPExcelDataProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelDataProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a data provider from Excel Services Application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Excel Services Application includes a set of common data providers on this list, For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` C:\PS>$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | { where {$_.providerID -eq "MyCustomProvider"} @@ -44,10 +42,12 @@ This example removes a custom data provider from the list of safe data providers Excel Services Application will no longer refresh any data connections that use this data provider. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelDataProvider object to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object. @@ -55,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelDataProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelFileLocation.md index 01d36a090..e11b7ed75 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelFileLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelFileLocation.md @@ -7,7 +7,7 @@ title: Remove-SPExcelFileLocation schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelFileLocation @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a trusted file location from Excel Services Application. - ## SYNTAX ``` @@ -27,26 +26,27 @@ Remove-SPExcelFileLocation [-Identity] ## DESCRIPTION The `Remove-SPExcelFileLocation` cmdlet removes a location from the list of trusted file locations. Excel Services Application loads only workbooks that are stored in a trusted file location. -Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. +Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. Excel Services Application always enforces the properties defined by the trusted file location from which a workbook was loaded. The properties used by the trusted file location are determined by comparing the file path for the workbook with the Address parameter of the trusted file location. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Get-SPExcelServiceApplication | Get-SPExcelFileLocation | where {$_.Address -ne "http://"} | Remove-SPExcelFileLocation ``` This example removes all nondefault trusted file locations from every Excel Services Application Web service application in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the FileLocation object to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that identifies the file location, in the form https://myPortal/myTeam; a valid string that identifies the path, in the form C:\folder_name; or an instance of a valid SPExcelFileLocation object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelFileLocationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -72,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +98,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelUserDefinedFunction.md index 9ff0d1cdb..995169a6f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelUserDefinedFunction.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPExcelUserDefinedFunction.md @@ -7,7 +7,7 @@ title: Remove-SPExcelUserDefinedFunction schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPExcelUserDefinedFunction @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a user-defined function from Excel Services Application. - ## SYNTAX ``` @@ -32,20 +31,21 @@ The Windows PowerShell cmdlets operate on the entries in the user-defined functi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Get-SPExcelServiceApplication | Remove-SPExcelUserDefinedFunction -Identity "SampleCompany.SampleApplication.SampleUdf" ``` This example removes the SampleCompany.SampleApplication.SampleUdf user-defined function from the list of user-defined functions for every Excel Services Application Web service application in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelUserDefinedFunction object that you want to remove. The type must be a valid name of the code assembly (for example, SampleCompany.SampleApplication.SampleUdf); or an instance of a valid SPExcelUDF object. @@ -53,8 +53,7 @@ The type must be a valid name of the code assembly (for example, SampleCompany.S ```yaml Type: SPExcelUDFPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the list of user-defined functions. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -71,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPInfoPathUserAgent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPInfoPathUserAgent.md index ad129383a..9b5bc3bdb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPInfoPathUserAgent.md @@ -7,7 +7,7 @@ title: Remove-SPInfoPathUserAgent schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPInfoPathUserAgent @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a user agent. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPIPUserAgent` cmdlet removes a specified user agent from the user a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Remove-SPInfoPathUserAgent -Identity "UserAgentName" ``` This example removes a user agent. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the user agent to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. @@ -50,7 +50,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPUserAgentPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedAccount.md index 70ff8aa62..eec171928 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedAccount.md @@ -7,7 +7,7 @@ title: Remove-SPManagedAccount schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPManagedAccount @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a managed account registration from the farm. - ## SYNTAX ``` @@ -32,20 +31,21 @@ The `Remove-SPManagedAccount` cmdlet removes account registration from the confi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE------------------- +### EXAMPLE ``` Remove-SPManagedAccount -Identity DOMAIN\ServiceAcct ``` This example removes the DOMAIN\ServiceAcct managed account from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -53,8 +53,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,13 +63,15 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a secure string for the new password (that is, $MySecureString). Works in conjunction with the ChangePassword parameter. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -ChangePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether a password is to be changed. Works in conjunction with the NewPassword parameter. When the ChangePassword value is set, a secure string value is required for the NewPassword parameter (that is, $MySecureString). @@ -109,8 +115,7 @@ When the ChangePassword value is set, a secure string value is required for the ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedPath.md index 49261f123..668a16cdf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPManagedPath.md @@ -7,7 +7,7 @@ title: Remove-SPManagedPath schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPManagedPath @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the specified managed path from the specified host header or Web application. - ## SYNTAX ### HostHeader @@ -44,10 +43,9 @@ Otherwise, you must specify the Web application that contains the managed path t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------------- +### EXAMPLE 1 ``` Remove-SPManagedPath "sites" -HostHeader ``` @@ -56,8 +54,7 @@ This example removes the sites managed path from the list of host-named site col Depending on the confirmation level of the local system, the preceding example can prompt prior to execution. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$false ``` @@ -65,18 +62,19 @@ Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$false This example removes the personal managed path from all Web applications in the farm. This command does not prompt for confirmation. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the managed path to delete. For example, in the URL https://sitename/sites/site1, "sites" is the name of the managed path. ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,13 +84,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Identity is a host header managed path. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,14 +102,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web application that hosts the managed path to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name, in the form WebApp2423. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -119,6 +121,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +135,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -165,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplication.md index 2a69c7b67..4b5a725f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplication.md @@ -7,7 +7,7 @@ title: Remove-SPPerformancePointServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPPerformancePointServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a PerformancePoint Service application from a farm. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPPerformancePointServiceApplication` cmdlet deletes a PerformancePo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------- +### EXAMPLE ``` Remove-SPPerformancePointServiceApplication -Identity PPSApp_01 ``` This example removes the PPSApp_01 PerformancePoint Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `et-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `et-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationProxy.md index 4c862d87b..f57e84dc1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: Remove-SPPerformancePointServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPPerformancePointServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the proxy for a PerformancePoint Service application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPPerformancePointServiceApplicationProxy` cmdlet deletes the proxy For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE-------------------- +### EXAMPLE ``` Remove-SPPerformancePointServiceApplicationProxy -Identity PPS_Application_Proxy_01 ``` This example removes the PPS_Application_Proxy_01 application proxy from its associated PerformancePoint Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application proxy to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application proxy (for example, PerfPointAppProxy1); or an instance of a valid SPPerformancePointMonitoringServiceApplicationProxy object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationTrustedLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationTrustedLocation.md index 699e85f96..c04b263ef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationTrustedLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPerformancePointServiceApplicationTrustedLocation.md @@ -7,7 +7,7 @@ title: Remove-SPPerformancePointServiceApplicationTrustedLocation schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPPerformancePointServiceApplicationTrustedLocation @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a single trusted location from a PerformancePoint Service application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPPerformancePointServiceApplicationTrustedLocation` cmdlet deletes For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE-------------------- +### EXAMPLE ``` Remove-SPPerformancePointServiceApplicationTrustedLocation -Identity ``` This example removes a Trusted Location having the specified GUID from a PerformancePoint Service Application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted location to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPPerformancePointMonitoringServiceApplicationTrustedLocation object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationTrustedLocationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPluggableSecurityTrimmer.md index b725e1fdb..cfeb567b0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPPluggableSecurityTrimmer.md @@ -7,7 +7,7 @@ title: Remove-SPPluggableSecurityTrimmer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPPluggableSecurityTrimmer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a pluggable security trimmer from a profile service application proxy. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPPluggableSecurityTrimmer` cmdlet to remove a specified pluggab For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` $pr = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInId 0 @@ -39,8 +37,7 @@ Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInI This example removes a pluggable security trimmer. - -### -----------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 @@ -48,10 +45,12 @@ Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -Plug This example turns off security trimming in a User Profile Service Application. - ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the User Profile service application proxy from which the pluggable security trimmer is removed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -59,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,13 +68,15 @@ Accept wildcard characters: False ``` ### -PlugInId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The index of the pluggable security trimmer must have an integer value greater than or equal to zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -93,8 +96,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileLeader.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileLeader.md index 2eec348df..a14417290 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileLeader.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileLeader.md @@ -7,7 +7,7 @@ title: Remove-SPProfileLeader schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPProfileLeader @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Remove a company leader. - ## SYNTAX ``` @@ -33,10 +32,9 @@ For additional information about SPProfileLeader cmdlets, see The *-SPProfileLea For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPProfileLeader -ProfileServiceApplicationProxy $proxy -Name "contoso\janedow" @@ -44,17 +42,18 @@ Remove-SPProfileLeader -ProfileServiceApplicationProxy $proxy -Name "contoso\jan This example removes the user "Jane Dow" from the leaders list for a specific user profile service application. - ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,14 +63,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name to be removed as a leader for the new User Profile Service application. For example, Contoso\Joe. ```yaml Type: SPProfileLeaderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -88,8 +92,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,14 +121,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileSyncConnection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileSyncConnection.md index 2533c6d5c..45affd119 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileSyncConnection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProfileSyncConnection.md @@ -7,7 +7,7 @@ title: Remove-SPProfileSyncConnection schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPProfileSyncConnection @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a synchronization connection. - ## SYNTAX ``` @@ -35,27 +34,27 @@ This cmdlet only works with Active Directory Synchronization Connections For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Remove-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" ``` This example removes a user from the fabrikam domain using a specific user profile service application. - ## PARAMETERS ### -ProfileServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the User Profile service application. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -ConnectionDomain + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the NetBIOS name of the domain you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -ConnectionForestName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the forest name you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -ConnectionPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the account used for directory connection. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -113,14 +118,16 @@ Accept wildcard characters: False ``` ### -ConnectionSynchronizationOU + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the top level organizational unit (OU) that you would like to synchronize. The value must be a domain name and you can only include one container per command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -ConnectionUserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to be used for the synchronization connection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -157,8 +169,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -168,6 +179,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -175,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -ConnectionNamingContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the naming context of the directory information tree to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -ConnectionServerName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the connection server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +234,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -224,7 +244,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProjectWebInstanceData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProjectWebInstanceData.md index 02d2829eb..c2095e472 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProjectWebInstanceData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPProjectWebInstanceData.md @@ -7,7 +7,7 @@ title: Remove-SPProjectWebInstanceData schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPProjectWebInstanceData @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Disassociates a Site Collection with the Project Server instance. - ## SYNTAX ``` @@ -28,17 +27,19 @@ This cmdlet disassociates the Project Server instance from the specified Site Co ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPProjectWebInstanceData -SiteCollection https://contoso/sites/pwa ``` This example disassociates https://contoso/sites/pwa from the Project Server instance. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Project Server 2016, Project Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Project Server 2016, Project Server 2019 Required: False Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: Project Server 2016, Project Server 2019 + The site collection to disassociate from the Project Server instance. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Project Server 2016, Project Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -96,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Project Server 2016, Project Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachineInfo.md index 107160694..b3788e259 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachineInfo.md @@ -7,7 +7,7 @@ title: Remove-SPRoutingMachineInfo schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPRoutingMachineInfo @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an external routing target. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPRoutingMachineInfo` cmdlet to remove an external routing targe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------EXAMPLE------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -44,17 +42,18 @@ Remove-SPRoutingMachineInfo -Identity $M This example removes a routing target for a specified identity. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the computer object that Request Manager will remove. ```yaml Type: SPRoutingMachineInfoPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachinePool.md index 62f4072bc..3c24a6438 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingMachinePool.md @@ -7,7 +7,7 @@ title: Remove-SPRoutingMachinePool schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPRoutingMachinePool @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a routing pool from Request Manager. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPRoutingMachinePool` cmdlet to remove a routing pool from the R For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -44,17 +42,18 @@ Remove-SPRoutingMachinePool -Identity $pool This example removes a routing pool for the specified identity by using the $pool variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Request Manager object to remove. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingRule.md index 25cb8d678..42cafaff4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPRoutingRule.md @@ -7,7 +7,7 @@ title: Remove-SPRoutingRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPRoutingRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a routing rule. - ## SYNTAX ``` @@ -29,10 +28,9 @@ If the Identity parameter is not specified, the routing rules for the entire far For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web @@ -51,17 +49,18 @@ Remove-SPRoutingRule -Identity $rule This example removes a routing for a specified identity by using the $rule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the rule object to remove. ```yaml Type: SPRoutingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +84,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPScaleOutDatabase.md index 5a98fdc71..b18a991c3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPScaleOutDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPScaleOutDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPScaleOutDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a specific scale-out database. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPScaleOutDatabase` cmdlet to remove a specific scale-out databa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -42,17 +40,18 @@ Remove-SPScaleOutDatabase -ServiceApplication $serviceApplication -Database $dat This example removes the specified scale-out database from the specified service application. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to remove. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application of the scale-out database to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -DeleteData + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to delete data when the scale out database is removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreApplication.md index 44661674a..9da6acd44 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreApplication.md @@ -7,7 +7,7 @@ title: Remove-SPSecureStoreApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSecureStoreApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a Secure Store application. - ## SYNTAX ``` @@ -28,27 +27,27 @@ The `Remove-SPSecureStoreApplication` cmdlet deletes a Secure Store application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApp" | Remove-SPSecureStoreApplication ``` This example removes the specified application and target. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Store application to delete. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreSystemAccount.md index 1c16548c5..a9c2a0b62 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSecureStoreSystemAccount.md @@ -7,7 +7,7 @@ title: Remove-SPSecureStoreSystemAccount schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSecureStoreSystemAccount @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a user account from a designated list. - ## SYNTAX ``` @@ -28,35 +27,34 @@ Use the `Remove-SPSecureStoreSystemAccount` cmdlet to remove a user account from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ``` Remove-SPSecureStoreSystemAccount -Identity contoso\jdoe ``` This example removes a specific user name jdoe by using the Identity parameter. - -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ``` Get-SPSecureStoreSystemAccount | Where-Object -filter {$_.AccountName -eq 'Contoso\admin'} | Remove-SPSecureStoreSystemAccount ``` This example removes the admin, user from the contoso domain by filtering the results from the `Get-SPSecureStoreSystemAccount` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name, object, or GUID to remove. ```yaml Type: SPSecureStoreSystemAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServerScaleOutDatabase.md index e82b3d513..3813f8212 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServerScaleOutDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPServerScaleOutDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServerScaleOutDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a specific scale-out database. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Remove-SPServerScaleOutDatabase -Database ## DESCRIPTION Use the Remove-SPServerScaleOutDatabase cmdlet to remove a specific scale-out database from a specified service application. - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Managed Metadata Service'} $database = Get-SPServerScaleOutDatabase -ServiceApplication $sa @@ -39,17 +37,18 @@ Remove-SPServerScaleOutDatabase -Database $database -ServiceApplication $sa This example removes the specified scale-out database from the Managed Metadata Service application. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to remove. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application of the scale-out database to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -82,8 +86,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -DeleteData + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to delete data when the scale out database is removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -132,7 +142,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplication.md index 73e608ac8..d7ee8441e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplication.md @@ -7,7 +7,7 @@ title: Remove-SPServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the specified service application on the local server. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Remove-SPServiceApplication` cmdlet deletes the specified service applicati For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------------- +### EXAMPLE ``` Remove-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -RemoveData ``` @@ -41,17 +39,18 @@ This example deletes the service application and its database. The service application GUID is unique to every farm. You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, or `Publish-SPServiceApplication`. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deletes all databases and other data associated with the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationPool.md index d2ecb1f27..4da483a43 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationPool.md @@ -7,7 +7,7 @@ title: Remove-SPServiceApplicationPool schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServiceApplicationPool @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Completely deletes the specified Web service application pool. - ## SYNTAX ``` @@ -28,27 +27,27 @@ The `Remove-SPServiceApplicationPool` cmdlet completely deletes the specified We For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPServiceApplicationPool TestServiceWebApplicationPool ``` This example deletes the selected service application pool. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web service application pool to delete. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxy.md index b9e575bc6..8a2288a7e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxy.md @@ -7,7 +7,7 @@ title: Remove-SPServiceApplicationProxy schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServiceApplicationProxy @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the specified service application proxy. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Remove-SPServiceApplicationProxy` cmdlet deletes the service application pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPServiceApplicationProxy $proxy @@ -42,6 +40,9 @@ This example deletes the User Profile Service Application proxy. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application proxy to remove. The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -49,8 +50,7 @@ The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,13 +60,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deletes all databases and other data associated with the service application proxy. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -83,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -93,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -100,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,6 +116,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -117,8 +126,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroup.md index 2f15e5e49..2b2310616 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroup.md @@ -7,7 +7,7 @@ title: Remove-SPServiceApplicationProxyGroup schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServiceApplicationProxyGroup @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Completely deletes the specified service application proxy group. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Completely deletes the specified service application proxy group. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------- +### EXAMPLE ``` Remove-SPServiceApplicationProxyGroup RemoteProxyGroup ``` @@ -42,17 +40,18 @@ The service application proxy group GUID is unique to every farm. You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The identity of the service application proxy group to delete. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroupMember.md index 69f49f1ae..7e2365507 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroupMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPServiceApplicationProxyGroupMember.md @@ -7,7 +7,7 @@ title: Remove-SPServiceApplicationProxyGroupMember schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPServiceApplicationProxyGroupMember @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes one or more proxies from the specified service application proxy group. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Remove-SPServiceApplicationProxyGroupMember` cmdlet removes one or more pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member babab30e-8e3a-428b-8ff4-4d5c8f455e6d ``` @@ -43,17 +41,18 @@ The service application proxy group GUID is unique to every farm. You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the service application proxy group from which to remove the member or members. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,13 +62,15 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the member or members to remove from the service application proxy group. ```yaml Type: SPServiceApplicationProxyPipeBind[] Parameter Sets: (All) Aliases: Proxy -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 2 @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPShellAdmin.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPShellAdmin.md index f6d57a654..5cf39a80f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPShellAdmin.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPShellAdmin.md @@ -7,7 +7,7 @@ title: Remove-SPShellAdmin schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPShellAdmin @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a user from the SharePoint_Shell_Access role. - ## SYNTAX ``` @@ -35,27 +34,27 @@ When you run this cmdlet to add a user to the SharePoint_Shell_Access role, the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ``` Remove-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` This example removes an existing user named User1 from the SharePoint_Shell_Access role in the database specified. - ## PARAMETERS ### -UserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the user you want to remove from the SharePoint_Shell_Access role in the specified database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,14 +107,16 @@ Accept wildcard characters: False ``` ### -database + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the database or the Database Object that includes the SharePoint_Shell_Access role from which the user is to be removed. If the database parameter is not specified, the configuration database is used. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSite.md index 698d9a1d0..6466d62d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSite.md @@ -7,7 +7,7 @@ title: Remove-SPSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Completely deletes an existing site collection and all subsites. - ## SYNTAX ``` @@ -28,17 +27,16 @@ Remove-SPSite [-Identity] [-DeleteADAccounts] [-GradualDelete] The **Remove-SPSite** cmdlet completely deletes an existing site collection and all subsites. This operation cannot be undone. - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Remove-SPSite -Identity 'https://sitename' -GradualDelete -Confirm:$False ``` This example removes the given site collection and all included sites by using GradualDelete which places the site in the site recycle bin; confirmation has been suppressed. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Remove-SPSite -Identity 'https://sitename' ``` @@ -48,14 +46,16 @@ This example immediately deletes the site and it's contents from the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the site to delete. The identity can be either a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +64,9 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -DeleteADAccounts + +> Applicable: SharePoint Server 2019 + Forces deletion of user accounts from Active Directory Domain Services (AD DS). This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. @@ -79,7 +82,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -CheckComplianceFlags -Specifies if compliance flags are enabled. + +> Applicable: SharePoint Server 2019 + +Specifies if compliance flags are enabled. ```yaml Type: Boolean @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. @@ -101,8 +110,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -DeleteADAccounts + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces deletion of user accounts from Active Directory Domain Services (AD DS). This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. @@ -136,8 +149,7 @@ This applies when in AD DS account creation mode and the value of this parameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +159,9 @@ Accept wildcard characters: False ``` ### -GradualDelete + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If provided, occurs gradually to use less system load. This operation is strongly recommended for deleting very large sites. This option places the site in the site recycle bin instead of immediately deleting the site. @@ -154,8 +169,7 @@ This operation is strongly recommended for deleting very large sites. This optio ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +179,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteMaster.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteMaster.md index 379f619de..9a88504e4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteMaster.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteMaster.md @@ -7,7 +7,7 @@ title: Remove-SPSiteMaster schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteMaster @@ -25,7 +25,7 @@ Remove-SPSiteMaster [-ContentDatabase] [-SiteId] Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to remove the site master. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -SiteId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the Site Master to remove. For example, ff480534-7e64-44a5-b7e3-7c418624cdf6. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -103,6 +110,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -110,7 +120,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscription.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscription.md index 85b1aa1c6..79e3259fd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscription.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscription.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscription schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscription @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes data stored in a subscription settings service application for a set of site subscriptions. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPSiteSubscription` cmdlet removes a site subscription along with al For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPSiteSubscription "https://contoso.com" ``` This example removes all data for the contoso.com site subscription (site collections, site subscription and settings). - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription settings service application that contains the service data to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the removal of a site subscription and is the only way to stop this command from prompting for confirmation. The type must be either of the following values: @@ -111,8 +117,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md index 6440120ff..6cc73bdfd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionBusinessDataCatalogConfig schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionBusinessDataCatalogConfig @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the Business Data Connectivity Metadata Store for a partition. - ## SYNTAX ``` @@ -29,20 +28,21 @@ To completely remove a partition and the data that it contains, run the `Clear-S For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso ``` This example removes the Business Data Connectivity Metadata Store for the partition http://contoso. - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context of the Business Data Connectivity Metadata Store to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePack.md index 837069475..b9c48267a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePack.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionFeaturePack schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionFeaturePack @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a SharePoint Feature set from a site subscription. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPSiteSubscriptionFeaturePack` cmdlet removes a SharePoint Feature s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE------------------------ +### EXAMPLE ``` Remove-SPFeatureSet -Identity "30daa535-b0fe-4d10-84b0-fb04029d161a" ``` This example removes a SharePoint Feature set that has the ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Feature set object to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePackMember.md index c6853c599..300d8738f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePackMember.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionFeaturePackMember.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionFeaturePackMember schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionFeaturePackMember @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a feature definition from the provided SharePoint Feature set. - ## SYNTAX ### AllFeatureDefinitions @@ -42,10 +41,9 @@ If the AllFeatureDefinitions flag is provided, all feature definitions are remov For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` C:\PS>$FS = Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" @@ -54,18 +52,19 @@ Remove-SPSiteSubscriptionFeaturePackMember -Identity $fs -FeatureDefinition (Get This example removes the PublishingSite feature from the Feature set that has ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" | Remove-SPSiteSubscriptionFeaturePackMember -AllFeatureDefinitions ``` This example removes all features from the Feature set 30daa535-b0fe-4d10-84b0-fb04029d161a. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Feature set from which to remove a feature. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -73,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -84,13 +82,15 @@ Accept wildcard characters: False ``` ### -AllFeatureDefinitions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Clears all features from the Feature set. ```yaml Type: SwitchParameter Parameter Sets: AllFeatureDefinitions -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,13 +100,15 @@ Accept wildcard characters: False ``` ### -FeatureDefinition + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the feature definition to be removed. ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: SingleFeatureDefinition -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +132,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -155,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionMetadataConfig.md index 0533d974f..cf2ef1149 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionMetadataConfig.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionMetadataConfig schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionMetadataConfig @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes site subscription configuration settings. - ## SYNTAX ``` @@ -29,20 +28,21 @@ Use the `Remove-SPSiteSubscriptionMetadataConfig` cmdlet to remove the site subs For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------- +### EXAMPLE ``` Remove-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` This example removes the site subscription-specific settings from an existing partitioned Metadata Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription for which to remove the Metadata Service application settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local metadata service proxy for the service application containing the site subscription-specific settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -68,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionProfileConfig.md index 172aa1130..5942c917b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionProfileConfig.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionProfileConfig schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionProfileConfig @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a site subscription from a User Profile Service application. - ## SYNTAX ### Default @@ -36,10 +35,9 @@ The `Remove-SPSiteSubscriptionProfileConfig` cmdlet deletes a site subscription For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ``` $sub = Get-SPSiteSubscription https://contoso/my $pr = Get-SPServiceApplicationProxy | ?{$_.DisplayName.Contains(PartitionedUserProfileApplication_Proxy)} @@ -48,10 +46,12 @@ Remove-SPSiteSubscriptionProfileConfig -Identity $sub -ProfileServiceApplication This example removes tenant data. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application that contains the site subscription to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -59,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,13 +69,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Name of the proxy of the User Profile Service application. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,13 +87,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for the User Profile service application to connect to. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -109,8 +115,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionSettings.md index 89689c6f7..fc4167805 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteSubscriptionSettings.md @@ -7,7 +7,7 @@ title: Remove-SPSiteSubscriptionSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteSubscriptionSettings @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the settings service data for a specified site subscription, or finds and removes orphaned data. - ## SYNTAX ### FindAllOrphans @@ -31,7 +30,6 @@ Remove-SPSiteSubscriptionSettings [-Identity] -Si [-AssignmentCollection ] [-Confirm] [-WhatIf] [] ``` - ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. @@ -46,10 +44,9 @@ If this cmdlet is run on a federated service application without specifying the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Remove-SPSiteSubscriptionSettings -FindAllOrphans -Whatif ``` @@ -57,18 +54,19 @@ Remove-SPSiteSubscriptionSettings -FindAllOrphans -Whatif This example finds all orphans and displays them on the screen. Remove the WhatIf parameter to remove these extra settings. - -### ------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Remove-SPSubscriptionSettingsServiceApplication -FindAllOrphans -AlternativeSiteSubscriptions $SubscriptionList ``` Use this example if the service application is consumed by a remote farm and you want the clean orphaned site subscription settings data (an array of all site subscriptions whose data must remain in the service application is assigned to the $SubscriptionList variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription settings service application that contains the service data to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -76,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -87,13 +84,15 @@ Accept wildcard characters: False ``` ### -FindAllOrphans + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that orphaned settings stores in the service application are deleted. ```yaml Type: SwitchParameter Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +102,9 @@ Accept wildcard characters: False ``` ### -SiteSubscriptions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscriptions with the settings service data to delete. The type must be an array of valid GUIDs. @@ -110,8 +112,7 @@ The type must be an array of valid GUIDs. ```yaml Type: Guid[] Parameter Sets: SpecifySiteSubscriptions -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,6 +122,9 @@ Accept wildcard characters: False ``` ### -AlternativeSiteSubscriptions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the complete collection or comma-separated list of site subscriptions that should exist in the settings service application. Any data not matching the items in this list will be removed. @@ -132,8 +136,7 @@ The type must be an array of valid GUIDs. ```yaml Type: Guid[] Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +146,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -154,8 +160,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +170,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +180,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -182,13 +189,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Automatically bypasses the secondary warning provided by the cmdlet prior to the operation. ```yaml Type: SwitchParameter Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +207,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -205,7 +217,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteURL.md index a24023243..87e794aca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteURL.md @@ -7,7 +7,7 @@ title: Remove-SPSiteURL schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteURL @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an URL mapping from the site. - ## SYNTAX ``` @@ -33,27 +32,27 @@ You cannot remove the primary URL for a given site collection, which is typicall For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPSiteURL -Url https://contoso.sharepoint.com ``` This example removes the URL from the site collection, https://contoso.sharepoint.com. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteUpgradeSessionInfo.md index 25827a93a..091cc6371 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteUpgradeSessionInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSiteUpgradeSessionInfo.md @@ -7,7 +7,7 @@ title: Remove-SPSiteUpgradeSessionInfo schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSiteUpgradeSessionInfo @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes an SPSite object from upgrade. - ## SYNTAX ``` @@ -30,27 +29,27 @@ If the site is not in the upgrade queue, the returned value is Null. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE------------- +### EXAMPLE ``` Get-SPSite | Remove-SPSiteUpgradeSessionInfo ``` This example removes the SPSite objects from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site from which to remove the site collections. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSocialItemByDate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSocialItemByDate.md index 678c5e24d..baa22e7fc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSocialItemByDate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSocialItemByDate.md @@ -7,7 +7,7 @@ title: Remove-SPSocialItemByDate schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSocialItemByDate @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes tags, notes, or ratings. - ## SYNTAX ``` @@ -31,27 +30,27 @@ Use the `Remove-SPSocialItemByDate` cmdlet to delete, tags, notes, ratings creat For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPSocialItemByDate -RemoveTags 1 -ProfileServiceApplicationProxy c6681d53-e6c4-432f-9f31-22d3de81b00c -EndDate 9/15/2009 ``` This example removes tags before 9/15/09 from the specified User Profile Service Application Proxy. - ## PARAMETERS ### -EndDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the date before which data is to be deleted. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -RemoveComments + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When this parameter is specified, comments will be removed. Valid values for this parameter are: @@ -126,8 +134,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -RemoveRatings + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When this parameter is specified, ratings will be removed. Valid values for this parameter are: @@ -147,8 +157,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -RemoveTags + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When this parameter is specified, tags will be removed. Valid values for this parameter are: @@ -168,8 +180,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +190,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +209,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -203,7 +219,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolution.md index a5aa7c1bf..73c6a4a06 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolution.md @@ -7,7 +7,7 @@ title: Remove-SPSolution schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSolution @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a SharePoint solution from a farm. - ## SYNTAX ``` @@ -29,20 +28,21 @@ Before you use this cmdlet, you must use the `Uninstall-SPSolution` cmdlet to re For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPSolution -Identity contoso_solution.wsp ``` This example removes the SharePoint solution contoso_solution.wsp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint solution to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,14 +103,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the removal of the SharePoint solution. You can use this parameter to remove SharePoint solutions that have been added to the server, even if they have not been deployed by using the `Install-SPSolution` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the language pack for the specified language. The type must be a valid language identifier; for example, 1033. @@ -124,8 +132,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolutionDeploymentLock.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolutionDeploymentLock.md index bdf82dc19..a09be4dc3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolutionDeploymentLock.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPSolutionDeploymentLock.md @@ -7,7 +7,7 @@ title: Remove-SPSolutionDeploymentLock schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPSolutionDeploymentLock @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the solution deployment lock for a server. - ## SYNTAX ``` @@ -29,20 +28,21 @@ If the Identity parameter is not specified, this cmdlet removes the solution dep For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPSolutionDeploymentLock ``` This example removes the solution deployment lock for all servers in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server for which the solution deployment lock is to be removed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPStateServiceDatabase.md index 85fa31e33..443dc5cc5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPStateServiceDatabase.md @@ -7,7 +7,7 @@ title: Remove-SPStateServiceDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPStateServiceDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a state service database from a state service application and drops it from the SQL Server. - ## SYNTAX ``` @@ -29,20 +28,21 @@ To remove a state service database and not delete the database, use the `Dismoun For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Remove-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example removes the specified database from a SharePoint Server farm and drops the database from the SQL Server (data loss). - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -51,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPThrottlingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPThrottlingRule.md index d96c795c7..219d3b28c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPThrottlingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPThrottlingRule.md @@ -7,7 +7,7 @@ title: Remove-SPThrottlingRule schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPThrottlingRule @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a throttling rule. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Remove-SPThrottlingRule` cmdlet to remove a throttling rule from the fa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -46,17 +44,18 @@ Remove-SPThrottlingRule -Identity $throttlingrule This example removes a throttling rule for a specified identity by using the $throttlingrule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the throttling rule object to remove. ```yaml Type: SPThrottlingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTranslationServiceJobHistory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTranslationServiceJobHistory.md index ee4bc185e..dcc34a1b5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTranslationServiceJobHistory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTranslationServiceJobHistory.md @@ -7,7 +7,7 @@ title: Remove-SPTranslationServiceJobHistory schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPTranslationServiceJobHistory @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes Machine Translation service jobs. - ## SYNTAX ``` @@ -29,20 +28,21 @@ Use the `Remove-SPTranslationServiceJobHistory` cmdlet to remove a machine trans For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE-------------- +### EXAMPLE ``` Remove-SPTranslationServiceJobHistory TranslationService -BeforeDate 2012/01/31 ``` This example removes all jobs completed before 2012/01/31 in the database associated with the Machine Translation Service application named TranslationService. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the instance of the Machine Translation service to remove. The type must be a valid URL, in the form https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -50,8 +50,7 @@ The type must be a valid URL, in the form https://server_name or a valid GUID (f ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -AllPartitions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes all the jobs from the database given other parameters. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -BeforeDate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies all expired jobs before a given date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -132,14 +139,16 @@ Accept wildcard characters: False ``` ### -IncludeActiveJobs + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies expired jobs which contain active translations. By default, jobs are not deleted if a translation is active. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +158,15 @@ Accept wildcard characters: False ``` ### -JobId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies only a job Id and its items to expire. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -PartitionId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies only a partition Id and its items to expire. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -188,7 +204,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedIdentityTokenIssuer.md index ea33d44b5..15bedf7e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedIdentityTokenIssuer.md @@ -7,7 +7,7 @@ title: Remove-SPTrustedIdentityTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPTrustedIdentityTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes a Security Token Service (STS) identity provider from the farm. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPTrustedIdentityTokenIssuer` cmdlet deletes a Security Token servic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE-------------------- +### EXAMPLE ``` Remove-SPTrustedIdentityTokenIssuer "LiveIDSTS" ``` This example removes an identity provider named LiveIDSTS from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity provider to remove. The type must be one of the following forms: @@ -53,8 +53,7 @@ The type must be one of the following forms: ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedRootAuthority.md index 74c64065e..768d6de38 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedRootAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a trusted root authority. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPTrustedRootAuthority` cmdlet deletes a trusted root authority from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPTrustedRootAuthority -Identity "WFEFarm1" ``` This example removes the trusted root authority WFEFarm1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted root authority to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -57,14 +56,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -97,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedSecurityTokenIssuer.md index 18ed4fe2f..774adc291 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedSecurityTokenIssuer.md @@ -7,7 +7,7 @@ title: Remove-SPTrustedSecurityTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPTrustedSecurityTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the trusted security token service object. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use the `Remove-SPTrustedSecurityTokenService` cmdlet to remove the trusted secu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPTrustedSecurityTokenService -Identity FarmA ``` This example removes the trusted security token issuer object named FarmA from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ID of the trusted security token issuer object to be removed. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedServiceTokenIssuer.md index f426b810c..228aebeb9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPTrustedServiceTokenIssuer.md @@ -7,7 +7,7 @@ title: Remove-SPTrustedServiceTokenIssuer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPTrustedServiceTokenIssuer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the object that represents the farm trust. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Remove-SPTrustedServiceTokenIssuer` cmdlet deletes the object that represen For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Remove-SPTrustedServiceTokenIssuer "WFE Farm 2" ``` This example deletes the trusted service token issuer WFE Farm 2. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted service token issuer to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -105,7 +111,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUsageApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUsageApplication.md index 5fa9863d9..df0dd8147 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUsageApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUsageApplication.md @@ -7,7 +7,7 @@ title: Remove-SPUsageApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPUsageApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a usage application from the local farm. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPUsageApplication` cmdlet deletes a usage application from the loca For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ``` Remove-SPUsageApplication -Identity "Usage and Health data collection" -RemoveData ``` This example removes the existing usage application and the associated logging DB. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the logging database is also removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Reserved for future use. ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUser.md index 7778dc1bf..ac9a75335 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUser.md @@ -7,7 +7,7 @@ title: Remove-SPUser schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPUser @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a user from a Web site. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The `Remove-SPUser` cmdlet does not remove the user from Active Directory Domain For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Remove-SPUser "Contoso\jdoe" -web https://test/web1 @@ -42,18 +40,19 @@ Get-SPWeb "https://test/web1" | Remove-SPUser "Contoso\jdoe" This example removes the user (Contoso\jdoe) from the Web application https://test/web1. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPSite https://contoso.com |Get-SPWeb |Remove-SPUser "Contoso\jdoe" ``` This syntax removes the user (Contoso\Jdoe) from every Web in a site collection located at https://contoso.com. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID, the user name, or SPUser object to remove. The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. @@ -62,7 +61,6 @@ The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -72,6 +70,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the URL or GUID from which the user is to be removed. This parameter is needed only if the identity provided is the user name. @@ -80,8 +81,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +105,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,14 +134,16 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The user only gets removed from that group. Otherwise, the user gets removed from the site. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +153,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -154,7 +163,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserLicenseMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserLicenseMapping.md index 85dd8125d..31623c8a0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserLicenseMapping.md @@ -7,7 +7,7 @@ title: Remove-SPUserLicenseMapping schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPUserLicenseMapping @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a claim-to-SharePoint user license mapping. - ## SYNTAX ``` @@ -28,28 +27,28 @@ The `Remove-SPUserLicenseMapping` cmdlet uses the Identity parameter to remove a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ``` Remove-SPUserLicenseMapping -Identity e69ba7cc-4be0-4723-ad63-58d06173afff ``` This example removes the claim-to-license mapping that has the unique ID, e69ba7cc-4be0-4723-ad63-58d06173afff. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique ID of a claim-to-license mapping. The type must be a valid GUID (that is, e69ba7cc-4be0-4723-ad63-58d06173afff). ```yaml Type: System.Collections.Generic.List`1[System.Guid] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSettingsProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSettingsProvider.md index 5af9fdfad..c122fd45b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSettingsProvider.md @@ -7,7 +7,7 @@ title: Remove-SPUserSettingsProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPUserSettingsProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a User Settings Provider. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use the `Remove-SPUserSettingsProvider` cmdlet to remove a User Settings Provide For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPUserSettingsProvider -Identity "234bf0ed-70db-4158-a332-4dfd683b4148" ``` This example removes a specific User Settings Provider by using the GUID, 234bf0ed-70db-4158-a332-4dfd683b4148. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID ID for a User Settings Provider to remove. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSolution.md index b1750d6f7..8e1e0742a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPUserSolution.md @@ -7,7 +7,7 @@ title: Remove-SPUserSolution schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPUserSolution @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a sandboxed solution from the solution gallery. - ## SYNTAX ``` @@ -29,20 +28,21 @@ Before you can remove the sandboxed solution from the solution gallery, you must For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE---------------------- +### EXAMPLE ``` Remove-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` This example removes the sandboxed solution contoso_solution.wsp from the site https://sitename. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution to remove. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -50,8 +50,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Remove the sandboxed solution from the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -68,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPVisioSafeDataProvider.md index 9a87420b0..1e8961f4f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPVisioSafeDataProvider.md @@ -7,7 +7,7 @@ title: Remove-SPVisioSafeDataProvider schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPVisioSafeDataProvider @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a data provider from a Visio Services application. - ## SYNTAX ``` @@ -29,32 +28,31 @@ The `Remove-SPVisioSafeDataProvider` cmdlet deletes the safe data provider that For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ``` Remove-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 ``` This example removes a safe data provider for a specified Visio Services application. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the data provider to delete. The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. The type must be a valid string that identifies the data provider. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +62,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the supported type of the data provider to delete. The type must be a valid identity of a data provider type. @@ -71,8 +72,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +82,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -89,8 +92,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPIBinding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPIBinding.md index d0f5055dd..a64d4021e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPIBinding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPIBinding.md @@ -7,7 +7,7 @@ title: Remove-SPWOPIBinding schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWOPIBinding @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ### Identity @@ -38,7 +37,7 @@ Remove-SPWOPIBinding [-All] [-AssignmentCollection ] [-C ``` ## DESCRIPTION -The `Remove-SPWOPIBinding` cmdlet removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. +The `Remove-SPWOPIBinding` cmdlet removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. After you run this cmdlet, you can use `New-SPWOPIBinding` to re-create the bindings as needed. If you remove all the bindings for an application, users cannot use Office Web Apps or the SharePoint Share by link feature for that application. If you remove all the bindings on the SharePoint farm where this cmdlet is run, users cannot use Office Web Apps or the SharePoint Share by link feature for any applications in the SharePoint library. @@ -47,43 +46,41 @@ If you want to stop using Office Web Apps for default clicks, but must preserve For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Remove-SPWOPIBinding -Application "Excel" ``` This example removes all bindings for Excel on the current SharePoint farm where this cmdlet is run. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Remove-SPWOPIBinding -All:$true ``` This example removes all bindings on the current SharePoint farm where this cmdlet is run. - -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Get-SPWOPIBinding -Action "MobileView" | Remove-SPWOPIBinding ``` This example removes all bindings for Office Mobile Web Apps on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the binding. ```yaml Type: SPWopiBindingPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -93,6 +90,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the action to remove bindings for. For example, "view," "edit," and "embedview." For a list of actions run `Get-SPWOPIBinding`. Most typically you will not use this parameter. @@ -101,8 +101,7 @@ If you specify some actions but not others, some features in SharePoint may not ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +111,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes all bindings. ```yaml Type: SwitchParameter Parameter Sets: RemoveAll -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +129,16 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies application to remove bindings for. Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the list of applications. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +148,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -156,8 +162,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -174,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -184,14 +191,16 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extensions to remove bindings for. Run `Get-SPWOPIBinding` to get the list of file name extensions. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +210,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the programmatic identifier (ProgID) for an application to remove bindings for. Run `Get-SPWOPIBinding` to get the list of ProgIDs. You may only want to use this parameter to remove bindings for OneNote. @@ -208,8 +220,7 @@ You may only want to use this parameter to remove bindings for OneNote. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,13 +230,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of WOPI application (like Office Web Apps Server) to remove bindings for. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,6 +248,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -242,7 +258,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -252,13 +267,15 @@ Accept wildcard characters: False ``` ### -WOPIZone + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the zone to remove bindings for. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPISuppressionSetting.md index 2c33ee54c..59fcfc836 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWOPISuppressionSetting.md @@ -7,7 +7,7 @@ title: Remove-SPWOPISuppressionSetting schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWOPISuppressionSetting @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes the suppression settings for a file name extension or programmatic ID and action on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ### DocTypeAndAction @@ -35,36 +34,35 @@ The `Remove-SPWOPISuppressionSetting` cmdlet removes the suppression settings fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Remove-SPWOPISuppressionSetting -Extension "XLSX" -Action "view" ``` This example removes suppression settings for viewing Excel workbooks that have the file name extension ".xlsx." - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Get-SPWOPISuppressionSetting | Remove-SPWOPISuppressionSetting ``` This example removes all suppression settings on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -Action -Specifies the action for a given file name extension or programmatic identifier (ProgId). + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the action for a given file name extension or programmatic identifier (ProgId). For example, "view," "edit," and "embedview." ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -74,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +86,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -103,7 +106,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -113,14 +115,16 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the file name extension. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +134,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a string that represents a SPWOPISuppressionSetting. Run `Get-SPWOPISuppressionSetting` to see examples of such strings. ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +153,16 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the programmatic identifier (ProgID) for an application to suppress. Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -171,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWeb.md index eec7edcdd..33f37797b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWeb.md @@ -7,7 +7,7 @@ title: Remove-SPWeb schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWeb @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Completely deletes the specified Web. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The **Remove-SPWeb** cmdlet completely deletes the Web specified by the Identity Deleting the top level Web site of a site collection causes the entire site collection to be removed. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Remove-SPWeb https://sitename/subsite ``` This example completely deletes a subsite. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web to delete. The type must be a valid full URL, in the form https://server_name/site_name, or an SPWeb object. @@ -49,8 +49,7 @@ The type must be a valid full URL, in the form https://server_name/site_name, or ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,7 +58,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -CheckComplianceFlags -Specifies if compliance flags are enabled. + +> Applicable: SharePoint Server 2019 + +Specifies if compliance flags are enabled. ```yaml Type: Boolean @@ -74,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -81,8 +86,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +106,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -109,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -126,13 +134,15 @@ Accept wildcard characters: False ``` ### -Recycle + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the SPWeb object should be recycled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplication.md index 6ab512058..0e6e3d8d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplication.md @@ -7,7 +7,7 @@ title: Remove-SPWebApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWebApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deletes the specified Web application. - ## SYNTAX ### RemoveZoneOfWebApp @@ -40,10 +39,9 @@ If no zone is provided, the entire Web application and all zones are removed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Get-SPWebApplication https://sitename | Remove-SPWebApplication -Zone "Internet" -Confirm ``` @@ -51,18 +49,19 @@ Get-SPWebApplication https://sitename | Remove-SPWebApplication -Zone "Internet" This example prompts and then removes the Internet zone Web application extension on the Web application at https://sitename. This command does not remove the content databases or the IIS Web site. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Remove-SPWebApplication https://sitename -Confirm -DeleteIISSite -RemoveContentDatabases ``` This example permanently removes the Web application, all content databases and the IIS Web site at https://sitename - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or name of the Web application to delete. The type must be a valid URL, in the form https://server_name, or a valid name, in the form WebApplication-1212. @@ -70,8 +69,7 @@ The type must be a valid URL, in the form https://server_name, or a valid name, ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -81,6 +79,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the five zones to be removed. If this parameter is not provided, all Web application zones are removed. @@ -89,8 +90,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: RemoveZoneOfWebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -139,14 +143,16 @@ Accept wildcard characters: False ``` ### -DeleteIISSite + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deletes the associated IIS Web sites. If this parameter is not provided, the IIS site is not removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +162,16 @@ Accept wildcard characters: False ``` ### -RemoveContentDatabases + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Permanently deletes all associated content databases. If this parameter is not provided, no content databases are removed. ```yaml Type: SwitchParameter Parameter Sets: RemoveWebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +181,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -180,7 +191,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplicationAppDomain.md index 633246285..bac1e7e50 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWebApplicationAppDomain.md @@ -7,7 +7,7 @@ title: Remove-SPWebApplicationAppDomain schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWebApplicationAppDomain @@ -29,13 +29,13 @@ This cmdlet also deletes the Internet Information Services (IIS) port binding if ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Remove-SPWebApplicationAppDomain -WebApplication https://www.contoso.com ``` Removes all of the app domains for the specified web application. -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Remove-SPWebApplicationAppDomain -WebApplication https://www.contoso.com -Zone Internet ``` @@ -44,13 +44,15 @@ Removes the app domains for the internet zone for the specified web application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object to remove. ```yaml Type: SPAppDomainPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,16 +62,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +82,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -96,15 +100,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWordConversionServiceJobHistory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWordConversionServiceJobHistory.md index 7f37faf9c..3591710b6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWordConversionServiceJobHistory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Remove-SPWordConversionServiceJobHistory.md @@ -7,7 +7,7 @@ title: Remove-SPWordConversionServiceJobHistory schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Remove-SPWordConversionServiceJobHistory @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes entries from the Word Automation Services job history database. - ## SYNTAX ``` @@ -29,28 +28,28 @@ The `Remove-SPWordConversionServiceJobHistory` cmdlet removes entries from the W For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ``` Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -BeforeDate 1/1/2009 ``` This example deletes all the items in the database before 1/1/2009. - -### ---------------------EXAMPLE 2------------------------ +### EXAMPLE 2 ``` Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -JobId 00000000-0000-0112-08FF-63927635FEF1 -IncludeActiveJobs ``` This example deletes the job with the specified ID, even if it is still processing. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Word Automation Services application to be processed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. @@ -58,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: WordServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +91,15 @@ Accept wildcard characters: False ``` ### -BeforeDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only jobs started before this date are to be removed. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -124,14 +128,16 @@ Accept wildcard characters: False ``` ### -IncludeActiveJobs + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that jobs that contain active conversions can be removed. By default, jobs that have active conversions are not removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +147,15 @@ Accept wildcard characters: False ``` ### -JobId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only the job with the specified ID is to be removed. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +165,15 @@ Accept wildcard characters: False ``` ### -SubscriptionId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only jobs corresponding to this subscription ID are to be removed. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +183,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -180,7 +193,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Rename-SPServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Rename-SPServer.md index 7da0f75f3..72e6eec74 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Rename-SPServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Rename-SPServer.md @@ -7,7 +7,7 @@ title: Rename-SPServer schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Rename-SPServer @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Renames a server that is currently connected to the farm. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The server itself must be manually renamed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Rename-SPServer -Identity "wfb1" -Name "WFE1" ``` This example changes the name of the SharePoint server wfb1 to WFE1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the original name of the server. The type must be a URL, in the form https://server_name, or a GUID, in the form 1234-4567-987gb. @@ -51,7 +51,6 @@ The type must be a URL, in the form https://server_name, or a GUID, in the form Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new name of the server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPManagedAccountDeployment.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPManagedAccountDeployment.md index 1260394a2..a6c0ba2df 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPManagedAccountDeployment.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPManagedAccountDeployment.md @@ -7,7 +7,7 @@ title: Repair-SPManagedAccountDeployment schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Repair-SPManagedAccountDeployment @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Repairs the local managed account credential deployment. - ## SYNTAX ``` @@ -30,20 +29,21 @@ The `Repair-SPManagedAccountDeployment` cmdlet should not be used as part of the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Repair-SPManagedAccountDeployment ``` This example repairs the deployment of credentials on all services and Web application associated with managed account (s) on the local server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +55,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -73,7 +75,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPProjectWebInstance.md index 8044155cd..ebc9a298f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPProjectWebInstance.md @@ -7,7 +7,7 @@ title: Repair-SPProjectWebInstance schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Repair-SPProjectWebInstance @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Re-queues specific Project Server queue items that may have fallen out of the queue. - ## SYNTAX ``` @@ -29,27 +28,27 @@ This includes triggers that may have been missed and queue jobs that were enqueu For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Repair-SPProjectWebInstance -Identity https://contoso-appsrv/PWA -RepairRule QueueMissingTriggers ``` This example enqueues any missing triggers for the Project Web App instance at https://contoso-appsrv/PWA. - ## PARAMETERS ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The identity of the instance of Project Web App. ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -RepairRule + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Valid values: QueueMissingTriggers searches the Project Web App for any triggers that might have been missed; QueueStaleServerGroups re-queues any jobs that were picked up by a server that was subsequently removed from the farm. ```yaml Type: ProjectSiteHealthRuleName Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPSite.md index 2cf657a8a..9316a952a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Repair-SPSite.md @@ -7,7 +7,7 @@ title: Repair-SPSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Repair-SPSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Activates the RunRepairs method against the referenced SPSite object. - ## SYNTAX ``` @@ -31,35 +30,34 @@ Run the `Test-SPSite` cmdlet for reports of rules which were run and a summary o For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE 1--------------- +### EXAMPLE 1 ``` Repair-SPSite https:///sites/testsite ``` This example runs all the site collection health checks in repair mode on the https://\/sites/testsite site collection. - -### ------------EXAMPLE 2--------------- +### EXAMPLE 2 ``` Repair-SPSite https:///sites/testsite -Rule "ee967197-ccbe-4c00-88e4-e6fab81145e1" ``` This example runs just the "Missing Galleries Check" in repair mode on the https://\/sites/testsite site collection. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site to run a repair. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +101,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,13 +110,15 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the specific site health rule to run instead of running all applicable rules at once. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +128,15 @@ Accept wildcard characters: False ``` ### -RunAlways + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces a rule to run even if a health check was run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Request-SPUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Request-SPUpgradeEvaluationSite.md index 7af0adaca..2f0c3e85f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Request-SPUpgradeEvaluationSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Request-SPUpgradeEvaluationSite.md @@ -7,7 +7,7 @@ title: Request-SPUpgradeEvaluationSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Request-SPUpgradeEvaluationSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Requests an upgrade evaluation site for a specified site. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Users can view the site to see how their site will work in the new experience. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $site=Get-SPSite https://contoso.com/sites/TeamSite1 Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email @@ -40,17 +38,18 @@ Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email This example requests an upgrade evaluation site the specified contoso.com team site. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPSite object for the new upgrade evaluation site collection. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,14 +102,16 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies not to send the requester and site collection administrators a notification email when the upgrade evaluation site is ready. The default value is not to send an email message. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -NoUpgrade + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies not to perform an upgrade as part of the process that creates the upgrade evaluation site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPAccessServicesDatabasePassword.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPAccessServicesDatabasePassword.md index 26e043729..8a862c900 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPAccessServicesDatabasePassword.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPAccessServicesDatabasePassword.md @@ -7,7 +7,7 @@ title: Reset-SPAccessServicesDatabasePassword schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Reset-SPAccessServicesDatabasePassword @@ -28,7 +28,7 @@ Resets the specified Access Services Database password with a randomly generated ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $contentdb = Get-SPContentDatabase ContentDbName $db = Get-SPAccessServicesDatabase -ContentDb $contentdb -EA 0 | select -First 1 @@ -37,10 +37,12 @@ Reset-SPAccessServicesDatabasePassword -Database $db -ServiceContext http://site Resets the database password for the specified Access Database. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The specified Access Services database. ```yaml Type: AccessServicesDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for the local Access Services application to connect to. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -118,7 +128,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectEventServiceSettings.md index ff818dffc..d986462d4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectEventServiceSettings.md @@ -7,7 +7,7 @@ title: Reset-SPProjectEventServiceSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Reset-SPProjectEventServiceSettings @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - ## SYNTAX ``` @@ -25,20 +24,21 @@ Reset-SPProjectEventServiceSettings [-AssignmentCollection Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +50,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectPCSSettings.md index 6854ab0cd..5967ce615 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectPCSSettings.md @@ -7,7 +7,7 @@ title: Reset-SPProjectPCSSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Reset-SPProjectPCSSettings @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Resets the settings for the Project Calculation Engine on Project Server. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The cmdlet requires you to identify the Project Server service application. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Reset-SPProjectPCSSettings -ServiceApplication $sa @@ -40,17 +38,18 @@ Reset-SPProjectPCSSettings -ServiceApplication $sa This cmdlet resets the settings for the Project Calculation Engine that is running on a Project Server Service Application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Project Server service application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectQueueSettings.md index f907cd442..b848df6ed 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPProjectQueueSettings.md @@ -7,7 +7,7 @@ title: Reset-SPProjectQueueSettings schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Reset-SPProjectQueueSettings @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Resets all Project Server Queue settings to their default values for a specific Project Server Service Application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Resets all Project Server Queue settings to their default values for a specific For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Reset-SPProjectQueueSettings -ServiceApplication $sa @@ -39,10 +37,12 @@ Reset-SPProjectQueueSettings -ServiceApplication $sa This example resets the queue settings for a Project Server Service Application service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name for a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -51,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPSites.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPSites.md index d3e77a402..2263a2810 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPSites.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Reset-SPSites.md @@ -7,7 +7,7 @@ title: Reset-SPSites schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Reset-SPSites @@ -29,10 +29,9 @@ It also ensures that all site collections in the content database are registered For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $contentdb = Get-SPContentDatabase ContentDbName Reset-SPSites -Identity $contentDb @@ -40,10 +39,12 @@ Reset-SPSites -Identity $contentDb Synchronizes the sites in the content database named ContentDbName with the configuration database. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +56,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,13 +66,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -82,13 +84,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies a specific content database. This could either be ID or Name of the content database or a valid instance of a content database. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -105,7 +112,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restart-SPAppInstanceJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restart-SPAppInstanceJob.md index 7d074afe0..52332c2ac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restart-SPAppInstanceJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restart-SPAppInstanceJob.md @@ -7,7 +7,7 @@ title: Restart-SPAppInstanceJob schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restart-SPAppInstanceJob @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $instance = Get-SPAppInstance -Web https://site_url | ?{$_.Title -eq 'Contoso App'} Restart-SPAppInstanceJob -AppInstance $instance @@ -40,13 +40,15 @@ Restarts the App Instance for the App named 'Contoso App' on https://site_url. ## PARAMETERS ### -AppInstance + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app instance object to restart. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -101,7 +110,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPDeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPDeletedSite.md index 26ecc695c..9eddc510b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPDeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPDeletedSite.md @@ -7,7 +7,7 @@ title: Restore-SPDeletedSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restore-SPDeletedSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Restores a deleted site collection. - ## SYNTAX ``` @@ -36,10 +35,9 @@ For additional information about a server-relative URL or understanding general For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` $deletedSite = Get-SPDeletedSite /sites/site_name Restore-SPDeletedSite -Identity $deletedSite @@ -47,10 +45,12 @@ Restore-SPDeletedSite -Identity $deletedSite This example restores a specific deleted site collection by using the site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the deleted site collection to be restored. The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. @@ -59,8 +59,7 @@ A site collection must not already exist at the URL location to perform a restor ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -109,14 +112,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -133,8 +141,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +161,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplication.md index 3762f0420..13b73d1a4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplication.md @@ -7,7 +7,7 @@ title: Restore-SPEnterpriseSearchServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restore-SPEnterpriseSearchServiceApplication @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Restores third-party backup of a search application. - ## SYNTAX ### Config @@ -53,10 +52,9 @@ However, Search Application Attach restores configuration, topology and all craw For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` $searchInstance = Get-SPEnterpriseSearchServiceInstance -local $applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" @@ -65,8 +63,7 @@ Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -A This example uses Application Configuration Attach mode to restore configuration data. - -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` $applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool -TopologyFile "C:\TopologyFile.xml" @@ -74,17 +71,18 @@ Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -A This example uses Search Application Attach mode to restore topology data in the file that is named topology.xml. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new Search application name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -94,13 +92,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application pool for the query web service. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,13 +110,15 @@ Accept wildcard characters: False ``` ### -AdminSearchServiceInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance to be used with the administration component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -126,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,12 +139,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,15 +152,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -167,6 +171,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the restoring the search application. The type must be a valid name of a SQL Server database, for example, RestoreDB1. @@ -174,8 +181,7 @@ The type must be a valid name of a SQL Server database, for example, RestoreDB1. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -185,13 +191,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the password for the database server on the SQL Server. ```yaml Type: SecureString Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +209,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. @@ -208,8 +219,7 @@ The type must be a valid SQL Server host name, for example, SQLServerHost1. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -219,13 +229,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name that is specified in the Database Server parameter. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,13 +247,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Use this parameter if you want the administration database to use a failover database server. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -251,13 +265,15 @@ Accept wildcard characters: False ``` ### -KeepId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the search service application ID's from the topology .xml file should be used for the restored search service application. ```yaml Type: SwitchParameter Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -267,15 +283,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -285,13 +302,15 @@ Accept wildcard characters: False ``` ### -TopologyFile + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of the .XML file that contains the application topology information. ```yaml Type: String Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -301,13 +320,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prevents database schema update during restore. Do not use. ```yaml Type: SwitchParameter Parameter Sets: Full -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplicationIndex.md index 20ed17df1..175466702 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplicationIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPEnterpriseSearchServiceApplicationIndex.md @@ -7,7 +7,7 @@ title: Restore-SPEnterpriseSearchServiceApplicationIndex schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restore-SPEnterpriseSearchServiceApplicationIndex @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Restores the search index from the specified backup files. - ## SYNTAX ### Restore @@ -44,10 +43,9 @@ The first set of parameters is for Application Configuration Attach mode and the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" @@ -56,8 +54,7 @@ Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -Handl This example starts a restore of the search index in the default search service application from a backup located at \\\\sample\backup\spbr0000. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Service Application" -Handle $handle @@ -65,17 +62,18 @@ Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Ser This example checks the status of the running job to restore of the search index in the search service application Search Service Application with the handle $handle . - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application that contains the index files that should be restored. ```yaml Type: SearchServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -85,13 +83,15 @@ Accept wildcard characters: False ``` ### -BackupFolder + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full file path of the backup files. ```yaml Type: String Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -101,13 +101,15 @@ Accept wildcard characters: False ``` ### -Handle + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A handle returned from an initial call using Parameter set 1. ```yaml Type: String Parameter Sets: RestoreProgress -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -117,13 +119,15 @@ Accept wildcard characters: False ``` ### -AllReplicas + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a switch to restore all replicas, not just the primary. ```yaml Type: SwitchParameter Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 3 @@ -133,15 +137,16 @@ Accept wildcard characters: False ``` ### -AllowMove -Specifies a switch to move instead of copying files when restoring. -Moving may be faster than copying. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies a switch to move instead of copying files when restoring. +Moving may be faster than copying. ```yaml Type: SwitchParameter Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 4 @@ -151,13 +156,15 @@ Accept wildcard characters: False ``` ### -Retries + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of times to retry if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 5 @@ -167,13 +174,15 @@ Accept wildcard characters: False ``` ### -RetryPauseSeconds + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Seconds to pause between retries if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 6 @@ -183,6 +192,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -194,8 +206,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +216,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -212,7 +226,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -222,6 +235,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -229,7 +245,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPFarm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPFarm.md index f2595bb22..448176711 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPFarm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPFarm.md @@ -7,7 +7,7 @@ title: Restore-SPFarm schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restore-SPFarm @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Restores one or more items from a backup. - ## SYNTAX ### DefaultSet @@ -41,36 +40,35 @@ This cmdlet can also be used to apply a farm template to the entire farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Restore-SPFarm -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod new -ConfigurationOnly ``` This example restores the configuration settings from the backup package in the \\\\file_server\share\Backup directory to the farm. - -### -------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Restore-SPFarm -ShowTree -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -Item "Microsoft SharePoint Foundation Web Application" -Verbose ``` This example show which components of the farm would be restored under the Microsoft SharePoint Foundation Web Application node, but does not actually restore them. - -### -------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -Force ``` This example restores a farm by using 10 threads and suppresses the overwrite warning. - ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path where SharePoint Products stored the backup package. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -86,8 +84,7 @@ The spbr* folders are created automatically. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +94,9 @@ Accept wildcard characters: False ``` ### -RestoreMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the method of restore to perform. The valid values are: @@ -107,8 +107,7 @@ The valid values are: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +117,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays which objects in the farm will be restored based on the other parameters passed to the `Restore-SPFarm` cmdlet namely the Item and ConfigurationOnly parameters. Items that will be excluded from the restore based on the other parameters passed to the `Restore-SPFarm` cmdlet will be preceded with an asterisk (*). Items that cannot be restored will be enclosed in square brackets (\[ \]). @@ -126,8 +128,7 @@ A restore operation will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +138,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -148,8 +152,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +162,9 @@ Accept wildcard characters: False ``` ### -BackupId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the backup package that is to be restored. Each backup package has a unique GUID associated with it. The GUID can be seen by using the `Get-SPBackupHistory` cmdlet to view the backup history. @@ -169,8 +175,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +185,15 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies settings only (no data) will be restored from the backup package and applied to objects on the destination farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +203,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -203,7 +213,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -213,6 +222,9 @@ Accept wildcard characters: False ``` ### -FarmCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials that will be used for all components being restored. For example, the application pool credentials for Web applications being restored. If an application pool being restored already exists in the farm, the credentials specified by the FarmCredentials parameter is ignored when restoring that application pool. @@ -220,8 +232,7 @@ If an application pool being restored already exists in the farm, the credential ```yaml Type: PSCredential Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -231,13 +242,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses the prompt warning that you will overwrite components when you perform an overwrite restore operation. ```yaml Type: SwitchParameter Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +260,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates the part of the backup package to be restored. You can use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if it has a unique name. If multiple items match the name, the full path must be provided. @@ -260,8 +276,7 @@ Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -271,17 +286,19 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid SQL Database Server name. If specified, will be used as a default Database Server name for all databases within the restore operation. -This parameter is only valid when restoring as new. +This parameter is only valid when restoring as new. It is not valid for overwrite restores. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -291,10 +308,13 @@ Accept wildcard characters: False ``` ### -Percentage + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Requests that progress updates about the restore operation be displayed in increments of that percentage. For example, a value of 5 displays restore progress updates at every 5 percent completed, and a value of 10 displays restore progress updates at every 10 percent completed. -Note: Progress will only be displayed in the output if the -Verbose parameter is specified. +Note: Progress will only be displayed in the output if the -Verbose parameter is specified. Otherwise, you may see the progress in the restore log file. This percentage is not precise and the actual progress updates might be lower or higher than requested. @@ -308,8 +328,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -319,9 +338,12 @@ Accept wildcard characters: False ``` ### -RestoreThreads + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The number of threads that should be used during the restore. -The fewer the restore threads, the easier it is to understand the restore log. +The fewer the restore threads, the easier it is to understand the restore log. However, the more restore threads, the more components can be restored in parallel, potentially resulting in a faster restore. The valid range is between 1 and 10. @@ -330,8 +352,7 @@ The default value is 3. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -341,6 +362,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -348,7 +372,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPSite.md index 9065c1684..5b4a606aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Restore-SPSite.md @@ -7,7 +7,7 @@ title: Restore-SPSite schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Restore-SPSite @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Restores a site collection. - ## SYNTAX ### DatabaseFromPipebind @@ -41,36 +40,35 @@ The `Restore-SPSite` cmdlet performs a restoration of the site collection to a l A content database may only contain one copy of a site collection. If a site collection is backed up and restored to a different URL location within the same Web application, an additional content database must be available to hold the restored copy of the site collection. - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Restore-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak ``` This example restores a site collection from the backup file C:\Backup\site_name.bak to the site collection URL https://server_name/sites/site_name. - -### ----------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Restore-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -Force -DatabaseServer SQLBE1 -DatabaseName SQLDB1 ``` This example restores a site collection backup from the backup file C:\Backup\site_name.bak, but overwrites the existing site collection at https://server_name/sites/site_name while specifying that the site collection must be stored in a specific content database. - -### ----------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ``` Restore-SPSite https://www.example.com -Path \\file_server\share\site_name.bak -HostHeaderWebApplication https://server_name ``` This example restores a site collection backup from the backup file \\\\file_server\share\site_name.bak to the host-named site collection https://www.example.com on the Web application https://server_name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL location to which the site collection is restored. A site collection does not have to already exist at the URL location to perform a restore. @@ -82,8 +80,7 @@ The type must be a valid URL, in the form https://server_name/sites/site_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -93,14 +90,16 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a valid path to the location of the backup. For example, C:\Backup\site_name.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -149,14 +152,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase -Specifies the SQL Server content database where the site collection data will be stored. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: DatabaseFromPipebind -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +171,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. @@ -174,8 +182,7 @@ The type must be a valid database name, in the form SQLDB1. ```yaml Type: String Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +192,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SQL Server containing the content database specified by the DatabaseName parameter. The type must be a valid database server name, in the form SQLBE1 and needs to be used in conjunction with the DatabaseName parameter. @@ -192,8 +202,7 @@ The type must be a valid database server name, in the form SQLBE1 and needs to b ```yaml Type: String Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +212,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the existing site collection at the URL location is to be overwritten by this restoration. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,14 +230,16 @@ Accept wildcard characters: False ``` ### -GradualDelete + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the site collection being overwritten with the Force parameter should be gradually deleted over time by a timer job instead of all at once, which reduces its impact on SharePoint Products and SQL Server performance. This option is recommended for large site collections. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -236,6 +249,9 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A valid URL assigned to the Web application by using alternate access mapping, such as https://server_name Restores a site collection as a host-named site collection instead of a path-based site collection. @@ -244,8 +260,7 @@ When the HostHeaderWebApplication parameter is present, the value of the Identit ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -262,7 +280,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -272,13 +289,15 @@ Accept wildcard characters: False ``` ### -PreserveSiteID + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Preserves the original Site ID instead of creating a new one. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPEnterpriseSearchServiceApplication.md index b8cff5f8c..17441b590 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPEnterpriseSearchServiceApplication.md @@ -7,7 +7,7 @@ title: Resume-SPEnterpriseSearchServiceApplication schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Resume-SPEnterpriseSearchServiceApplication @@ -27,10 +27,9 @@ This cmdlet reads the SearchServiceApplication object and moves it from the Paus For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA $ssa | Resume-SPEnterpriseSearchServiceApplication @@ -41,6 +40,9 @@ This example obtains a reference to a search service application named MySSA and ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to resume. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, MyQueryServer); or an instance of a valid SearchServiceApplication object. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPProjectWebInstance.md index b0d620898..157fe79ec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPProjectWebInstance.md @@ -7,7 +7,7 @@ title: Resume-SPProjectWebInstance schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Resume-SPProjectWebInstance @@ -29,10 +29,9 @@ The database must be set to read-write before you run this cmdlet, or this cmdle For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} $instance = Get-SPProjectWebInstance -ServiceApplication $sa @@ -44,14 +43,16 @@ Resumes the Project Web Server Instance in the Project Web Application Service A ## PARAMETERS ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the instance of Project Web App to be switched to read-write mode. It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPStateServiceDatabase.md index 6d9b65004..c82bd91ec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Resume-SPStateServiceDatabase.md @@ -7,7 +7,7 @@ title: Resume-SPStateServiceDatabase schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Resume-SPStateServiceDatabase @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Resumes a paused state service database so that new rows of data are received. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Resume-SPStateServiceDatabase` cmdlet resumes a paused state service databa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ``` $db = Get-SPStateServiceDatabase -Identity StateServceDbName Resume-SPStateServiceDatabase -Identity $db @@ -39,10 +37,12 @@ Resume-SPStateServiceDatabase -Identity $db This example resumes a paused state service database. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to resume. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -51,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPBusinessDataCatalogMetadataObject.md index 91e730979..93db4b869 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPBusinessDataCatalogMetadataObject.md @@ -7,7 +7,7 @@ title: Revoke-SPBusinessDataCatalogMetadataObject schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Revoke-SPBusinessDataCatalogMetadataObject @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Revokes a right to a principal in the specified Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Revoke-SPBusinessDataCatalogMetadataObject` cmdlet revokes a right granted For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName $MetadataObject = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase" @@ -41,17 +39,18 @@ Revoke-SPBusinessDataCatalogMetadataObject -Identity $MetadataObject -Principal This example removes the execute right from the External System with the name ContosoDatabase for the user with the identity of johndoe on the domain CONTOSO. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the principal to whom the rights apply. The type must be a claim. @@ -68,8 +70,7 @@ The type must be a claim. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the right to revoke the principal. The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. @@ -86,8 +90,7 @@ The type must be one of the following valid PSBdcRight object types: All, Execut ```yaml Type: PSBdcRight Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom environment settings model slice for which to revoke the right. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -143,8 +153,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -161,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPObjectSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPObjectSecurity.md index 52e633d60..c96f00a34 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPObjectSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Revoke-SPObjectSecurity.md @@ -7,7 +7,7 @@ title: Revoke-SPObjectSecurity schema: 2.0.0 author: techwriter40 ms.author: pamgreen -ms.reviewer: +ms.reviewer: --- # Revoke-SPObjectSecurity @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes a security principal from a SPObjectSecurity object. - ## SYNTAX ### RevokeOne @@ -40,10 +39,9 @@ An SPObjectSecurity object is a common object that is used to represent the secu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $security = Get-SPServiceApplicationSecurity $serviceApp -Admin Revoke-SPObjectSecurity $security "domain\user" @@ -53,18 +51,19 @@ Set-SPServiceApplicationSecurity $serviceApp -Admin $security This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and removes a user from that ACL. The removed an administrator for the service application $serviceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the SPObjectSecurity object from which the security principal is removed. You can use the `Get-SPServiceApplicationSecurity` cmdlet to get a SPObjectSecurity object . ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: 1 @@ -74,6 +73,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the principal for whom the rights are removed. The type must a valid name a principal; for example, Full Control. @@ -81,8 +83,7 @@ The type must a valid name a principal; for example, Full Control. ```yaml Type: SPClaim Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: 2 @@ -92,6 +93,9 @@ Accept wildcard characters: False ``` ### -Rights + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the rights of the principal to revoke. The type must a valid array of strings that represents the rights of the principal to revoke. @@ -99,8 +103,7 @@ The type must a valid array of strings that represents the rights of the princip ```yaml Type: String[] Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: 3 @@ -110,13 +113,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies that all security principals are removed from the specified SPObjectSecurity object. ```yaml Type: SwitchParameter Parameter Sets: RevokeAll -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -137,8 +145,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchConfiguration.md index 87527b095..42aea04a8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchConfiguration.md @@ -32,7 +32,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FastSearchConfiguration -LogFile C:\log.txt ``` @@ -42,13 +42,15 @@ This example configures the local machine and writes the log output to C:\log.tx ## PARAMETERS ### -LogFile + +> Applicable: FAST Server for SharePoint 2010 + Specifies the full path of a file where all log messages will be written. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchIPSec.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchIPSec.md index 3e52af1ce..927dc897f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchIPSec.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchIPSec.md @@ -39,14 +39,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchIPSec -Create -UserName user1 -Password xxx ``` This example sets up Internet Protocol security on the local machine. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Set-FASTSearchIPSec -Remove ``` @@ -56,13 +56,15 @@ This example removes Internet Protocol security rules from the local machine. ## PARAMETERS ### -Create + +> Applicable: FAST Server for SharePoint 2010 + Specifies that IPsec rules will be created. ```yaml Type: SwitchParameter Parameter Sets: Create -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -72,13 +74,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: FAST Server for SharePoint 2010 + Specifies the password of the domain user that can look up machines in the domain controller. ```yaml Type: SecureString Parameter Sets: Create -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -88,13 +92,15 @@ Accept wildcard characters: False ``` ### -Remove + +> Applicable: FAST Server for SharePoint 2010 + Specifies that IPsec rules will be deleted. ```yaml Type: SwitchParameter Parameter Sets: Remove -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -104,13 +110,15 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: FAST Server for SharePoint 2010 + Specifies the username of the domain user that can look up machines in the domain controller. ```yaml Type: String Parameter Sets: Create Aliases: User -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -120,13 +128,15 @@ Accept wildcard characters: False ``` ### -LogFile + +> Applicable: FAST Server for SharePoint 2010 + Specifies the full path of a file where all log messages will be written. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCategory.md index 918c189d2..0c161f107 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCategory.md @@ -47,7 +47,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataCategory -Name Titles -DiscoverNewProperties 1 -MapToContents 1 ``` @@ -58,7 +58,7 @@ A crawled property is considered a member of the category if it has the same pro This example also sets MapToContents so that new crawled properties are mapped to the "content" full text index. If you do not want a newly discovered crawled property made available through the full text index, override this action by setting the specific crawled property's IsMappedToContents parameter to false. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataCategory -Name ExtendedTitle -Newname Titles ``` @@ -68,13 +68,15 @@ This example changes the name of the category "ExtendedTitle" to "Titles". ## PARAMETERS ### -Category + +> Applicable: FAST Server for SharePoint 2010 + Specifies the category to be changed. ```yaml Type: Category Parameter Sets: Category -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -84,13 +86,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the category to update. ```yaml Type: String Parameter Sets: Name Aliases: CategoryName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -100,6 +104,9 @@ Accept wildcard characters: False ``` ### -MapToContents + +> Applicable: FAST Server for SharePoint 2010 + If this parameter is set to true, all newly created or discovered properties (if automatic discovery is enabled) are added to the "content" full text index. The name of each crawled property is added to the "crawledpropertynames" managed property. @@ -107,8 +114,7 @@ The name of each crawled property is added to the "crawledpropertynames" managed ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -118,13 +124,15 @@ Accept wildcard characters: False ``` ### -DiscoverNewProperties + +> Applicable: FAST Server for SharePoint 2010 + If this parameter is set to true, previously unknown crawled properties mapped to this category (having the same property set identifier) are created and added to the category. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -134,13 +142,15 @@ Accept wildcard characters: False ``` ### -NewName + +> Applicable: FAST Server for SharePoint 2010 + The new name for the category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledProperty.md index ee7b8e0ff..2ff0831c5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledProperty.md @@ -40,7 +40,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$description = Get-FASTSearchMetadataCrawledProperty -Name Description $description # Before @@ -53,13 +53,15 @@ This example automatically maps a crawled property to the full text index "conte ## PARAMETERS ### -CrawledProperty + +> Applicable: FAST Server for SharePoint 2010 + An object representing the crawled property to update. ```yaml Type: CrawledProperty Parameter Sets: CrawledProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -69,13 +71,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the crawled property to update. ```yaml Type: String Parameter Sets: Name Aliases: CrawledPropertyName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Propset + +> Applicable: FAST Server for SharePoint 2010 + The property set GUID of the crawled property which is being updated. The GUID controls which category the crawled property is part of. @@ -94,8 +101,7 @@ The accepted GUID format is "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" or a System.G ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -VariantType + +> Applicable: FAST Server for SharePoint 2010 + An integer value specifying the variant type of the updated crawled property. See https://go.microsoft.com/fwlink/?LinkId=163232 (https://go.microsoft.com/fwlink/?LinkId=163232) for a list of common variant types. @@ -112,8 +121,7 @@ See https://go.microsoft.com/fwlink/?LinkId=163232 (https://go.microsoft.com/fwl ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -123,13 +131,15 @@ Accept wildcard characters: False ``` ### -IsMappedToContents + +> Applicable: FAST Server for SharePoint 2010 + This Boolean parameter specifies whether or not the content of the crawled property should be automatically mapped into the default full text index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledPropertyMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledPropertyMapping.md index 9a618cbee..148080198 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledPropertyMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataCrawledPropertyMapping.md @@ -39,7 +39,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$title = Get-FASTSearchMetadataManagedProperty -Name title $extendedtitle = Get-FASTSearchMetadataManagedProperty -name extendedtitle @@ -56,6 +56,9 @@ This replaces any existing crawled property mappings for the managed property "e ## PARAMETERS ### -CrawledPropertyMapping + +> Applicable: FAST Server for SharePoint 2010 + The list of crawled property mappings applied to the specified managed property. The order in the list controls which crawled property is used when multiple crawled properties exist. The list must consist of one or more Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledPropertyImpl objects. @@ -63,8 +66,7 @@ The list must consist of one or more Microsoft.SharePoint.Search.Extended.Admini ```yaml Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledProperty] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + An object representing a managed property. ```yaml Type: ManagedProperty Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the managed property whose crawled property mappings you are updating. ```yaml Type: String Parameter Sets: Name Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndex.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndex.md index d94adaaea..212d6e28c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndex.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndex.md @@ -39,14 +39,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataFullTextIndex -name content -description "Central content repository" ``` This example updates the description of the existing full text index named "content". -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataFullTextIndex -Name content -StemmingEnabled 1 ``` @@ -57,13 +57,15 @@ The content of the full text index must be recrawled/re-fed for this change to t ## PARAMETERS ### -FullTextIndex + +> Applicable: FAST Server for SharePoint 2010 + An object representing the full text index to be updated. ```yaml Type: FullTextIndex Parameter Sets: FullTextIndex -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + Name of the full text index to be updated. ```yaml Type: String Parameter Sets: Name Aliases: FullTextIndexName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -89,13 +93,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A new description to use for the full text index. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -105,13 +111,15 @@ Accept wildcard characters: False ``` ### -StemmingEnabled + +> Applicable: FAST Server for SharePoint 2010 + Enables or disables stemming for this full text index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndexMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndexMapping.md index f63814b79..83000af15 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndexMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataFullTextIndexMapping.md @@ -40,7 +40,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$content = get-fastsearchmetadatafulltextindex -name content $sitetitle = Get-FASTSearchMetadataManagedProperty -name sitetitle @@ -57,6 +57,9 @@ Finally, the example calls the Set-FASTSearchMetadataFullTextIndexMapping cmdlet ## PARAMETERS ### -Level + +> Applicable: FAST Server for SharePoint 2010 + The importance level to use for this mapping. Valid values are 1 through 7. @@ -64,7 +67,6 @@ Valid values are 1 through 7. Type: Int32 Parameter Sets: (All) Aliases: ImportanceLevel, L -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -Mapping + +> Applicable: FAST Server for SharePoint 2010 + The full text index object to update. ```yaml Type: FullTextIndexMapping Parameter Sets: (All) Aliases: FullTextIndexMapping, M -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataManagedProperty.md index b4768d6fa..d3501784a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataManagedProperty.md @@ -46,7 +46,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -Refinement 1 @@ -56,7 +56,7 @@ This example enables refinement for the managed property "title". Content must be re-fed/recrawled to populate the refinement. Until it is populated, the refinement defaults to having no value. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -Queryable 1 @@ -69,7 +69,7 @@ Relevancy is not calculated for such queries (unlike searches against the full t The content must be recrawled/re-fed for this to take effect. -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` C:\PS>$title = Get-FASTSearchMetadataManagedProperty -name title Set-FASTSearchMetadataManagedProperty -ManagedProperty $title -SummaryType 1 @@ -83,13 +83,15 @@ The content must be recrawled/re-fed for this to take effect. ## PARAMETERS ### -ManagedProperty + +> Applicable: FAST Server for SharePoint 2010 + The managed property object to modify. ```yaml Type: ManagedProperty Parameter Sets: ManagedProperty -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -99,13 +101,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the managed property to modify. ```yaml Type: String Parameter Sets: Name Aliases: ManagedPropertyName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -115,13 +119,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A text string describing the managed property's use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -131,6 +137,9 @@ Accept wildcard characters: False ``` ### -MergeCrawledProperties + +> Applicable: FAST Server for SharePoint 2010 + This Boolean value controls whether or not multiple crawled properties mapped to this managed property are merged when multiple crawled properties are present in the input. If not set, only the first element of the first non-empty crawled property is stored in the managed property. @@ -141,8 +150,7 @@ The content must be re-fed/recrawled for this change to take effect. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -152,6 +160,9 @@ Accept wildcard characters: False ``` ### -Queryable + +> Applicable: FAST Server for SharePoint 2010 + This Boolean value specifies whether or not the managed property is directly searchable on its own (and not only as part of a full text index). If not set, it can only be searched when included in a full text index. @@ -161,8 +172,7 @@ The content must be recrawled/re-fed again for this change to take effect. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -172,6 +182,9 @@ Accept wildcard characters: False ``` ### -RefinementEnabled + +> Applicable: FAST Server for SharePoint 2010 + This Boolean value specifies whether or not a refiner is available for the managed property. Refiners group search results based on the values of individual managed properties from the complete result set of a query. @@ -182,8 +195,7 @@ After enabling refinement on a managed property, the content must be recrawled/r ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -193,6 +205,9 @@ Accept wildcard characters: False ``` ### -SortableType + +> Applicable: FAST Server for SharePoint 2010 + The sorting type of the managed property. Valid values are: @@ -211,8 +226,7 @@ Managed properties of the type datetime always have sorting enabled. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -222,6 +236,9 @@ Accept wildcard characters: False ``` ### -SummaryType + +> Applicable: FAST Server for SharePoint 2010 + The type of summary to return for the managed property. Valid values are: @@ -234,8 +251,7 @@ The content must be recrawled/re-fed for any change in this setting to take effe ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -245,6 +261,9 @@ Accept wildcard characters: False ``` ### -StemmingEnabled + +> Applicable: FAST Server for SharePoint 2010 + Enables or disables stemming for the managed property. Stemming is the process of reducing words to their base form, or expanding to all known forms, to increase recall. @@ -255,8 +274,7 @@ The content must be recrawled/re-fed for this to take effect. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -266,6 +284,9 @@ Accept wildcard characters: False ``` ### -DecimalPlaces + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter specifies how many decimal places should be used for the managed property. A higher number of decimals provides a more precise result, but reduces the minimum and maximum number size that can be stored in the managed property. @@ -273,8 +294,7 @@ A higher number of decimals provides a more precise result, but reduces the mini ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -284,6 +304,9 @@ Accept wildcard characters: False ``` ### -MaxIndexSize + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the maximum number of kilobytes indexed for the managed property. Valid values range from 0 through 2097151 (2GB). @@ -293,8 +316,7 @@ The measured value equals the data stored prior to indexing and is slightly larg ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -304,6 +326,9 @@ Accept wildcard characters: False ``` ### -MaxResultSize + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the maximum number of kilobytes that can be returned for this managed property. If a managed property's content is longer than this, then the returned version of the managed property is truncated to the specified value. @@ -315,8 +340,7 @@ If the summary type of the managed property is dynamic, then this size refers to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -326,13 +350,15 @@ Accept wildcard characters: False ``` ### -IsMapped + +> Applicable: FAST Server for SharePoint 2010 + This Boolean parameter specifies whether or not the managed property is mapped to support Alternate Access Mappings in SharePoint. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataRankProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataRankProfile.md index 68ae5a0ce..9f4855c88 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataRankProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchMetadataRankProfile.md @@ -46,7 +46,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -QualityWeight 100 -AuthorityWeight 200 -QueryAuthorityWeight 10 -FreshnessWeight 0 ``` @@ -56,7 +56,7 @@ You can specify one or more weights to modify at a time. This example turns off the freshness relevancy component by setting the weight to 0, while adjusting the other components. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$processingtime = Get-FASTSearchMetadataManagedProperty -name Processingtime Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -FreshnessManagedPropertyReference $processingtime @@ -67,7 +67,7 @@ This example changes the "ExtraRankProfile" rank profile so that it no longer de Instead, freshness is based on when the item was last processed (fed) into the FAST Search Server 2010 for SharePoint system. The time the item was processed is stored in the "processingtime" managed property by default. -### ---------------EXAMPLE 3----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 3 (FAST Server for SharePoint 2010) ``` Set-FASTSearchMetadataRankProfile -Name ExtraRankProfile -StopWordThreshold 100000 ``` @@ -77,7 +77,7 @@ The stop word threshold determines if the query term is too common to be taken i Lowering the stop word threshold means that more terms may be ignored when calculating relevancy, which can have a positive impact on performance. -### ---------------EXAMPLE 4----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 4 (FAST Server for SharePoint 2010) ``` C:\PS>$rankprofile = Get-FASTSearchMetadataRankProfile -Name default $rankprofile.GetQualityComponents() @@ -86,7 +86,7 @@ $rankprofile.GetQualityComponents() The quality rank metric is an importance score assigned to a document, independent of query terms. This example lists the managed properties involved in calculating the quality rank by calling the GetQualityComponents() method call on the rank profile. -### ---------------EXAMPLE 5----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 5 (FAST Server for SharePoint 2010) ``` C:\PS>$new_rank_component = New-FASTSearchMetadataManagedProperty -Name sitecredibility $rankprofile = Get-FASTSearchMetadataRankProfile -Name default @@ -103,13 +103,15 @@ The next step would be to populate "sitecredibility" with a suitable crawled pro ## PARAMETERS ### -Name + +> Applicable: FAST Server for SharePoint 2010 + The name of the rank profile to modify. ```yaml Type: String Parameter Sets: Name Aliases: RankProfileName, N -Applicable: FAST Server for SharePoint 2010 Required: True Position: Named @@ -119,13 +121,15 @@ Accept wildcard characters: False ``` ### -RankProfile + +> Applicable: FAST Server for SharePoint 2010 + An object representing a rank profile. ```yaml Type: RankProfile Parameter Sets: RankProfile -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -135,6 +139,9 @@ Accept wildcard characters: False ``` ### -AuthorityWeight + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the authority weight component of the rank profile. Ranking on authority takes the connections between items into account when calculating a relevancy score. @@ -145,8 +152,7 @@ The authority relevancy score is calculated regularly by the Webanalyzer compone ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -156,6 +162,9 @@ Accept wildcard characters: False ``` ### -FreshnessManagedPropertyReference + +> Applicable: FAST Server for SharePoint 2010 + This parameter specifies which managed properties to use when calculating freshness. The managed property must be represented with a ManagedPropertyImpl object (e.g., as returned from Get-FASTSearchMetadataManagedProperty). @@ -168,8 +177,7 @@ Items with an older datetime value in the specified managed property get a lower ```yaml Type: ManagedProperty Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -179,6 +187,9 @@ Accept wildcard characters: False ``` ### -FreshnessResolution + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the size of the freshness boost tick. The tick is the smallest amount of time the freshness relevancy considers to be a different value. @@ -202,8 +213,7 @@ Valid values are: ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -213,6 +223,9 @@ Accept wildcard characters: False ``` ### -FreshnessWeight + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the weight of the freshness relevancy component when calculating the relevance of a result. The freshness rank value goes down the older the document is. @@ -224,8 +237,7 @@ Set this value to 0 to ignore item freshness when calculating relevancy. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -235,6 +247,9 @@ Accept wildcard characters: False ``` ### -PositionStopWordThreshold + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the position stop word threshold. If a query term occurs more often than position-stop-word-threshold (independent of the number of items it occurs in), then proximity relevancy calculations are not done for that term. @@ -247,8 +262,7 @@ This will decrease CPU use when searching. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -258,6 +272,9 @@ Accept wildcard characters: False ``` ### -QualityWeight + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the weight of the quality component of the relevancy model. Quality denotes the assigned importance of a document. @@ -271,8 +288,7 @@ The GetQualityComponents() method available on the RankProfileImpl object lists ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -282,6 +298,9 @@ Accept wildcard characters: False ``` ### -QueryAuthorityWeight + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the weight of the query authority relevancy component. The query authority increases for an item when a user clicks through to it from search results. @@ -290,8 +309,7 @@ The more popular the item is for a given query, the higher the query authority r ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -301,13 +319,15 @@ Accept wildcard characters: False ``` ### -RankModelName + +> Applicable: FAST Server for SharePoint 2010 + The name of a rank profile to modify. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -317,6 +337,9 @@ Accept wildcard characters: False ``` ### -StopWordThreshold + +> Applicable: FAST Server for SharePoint 2010 + This integer parameter sets the stop word threshold of the rank profile. A stop word is a search term that is so common in the result set that it is not counted as part of the relevancy calculation. @@ -329,8 +352,7 @@ A low StopWordThreshold value gives better search performance, but a lower resul ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityCCTKServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityCCTKServer.md index 7142dbbac..802a8b8e3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityCCTKServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityCCTKServer.md @@ -29,7 +29,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1---------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityCCTKServer -Port 13271 -Enable $true ``` @@ -39,13 +39,15 @@ This example updates the CCTK server port number and enables the CCTK server to ## PARAMETERS ### -Port + +> Applicable: FAST Server for SharePoint 2010 + The port number that the security manager listens to for handling CCTK requests. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: FAST Server for SharePoint 2010 + A Boolean flag to determine if the CCTK service will accept requests. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -GeneralSetting + +> Applicable: FAST Server for SharePoint 2010 + A CCTKServerSetting instance whose property values are used for the CCTKServerSetting being updated. ```yaml Type: CCTKServerSetting Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityClaimsUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityClaimsUserStore.md index 74f1ab253..b2f1f715f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityClaimsUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityClaimsUserStore.md @@ -29,14 +29,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityClaimsUserStore -Identity clm -Description "SharePoint Users" ``` This example updates the description of the "clm" claims user store. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityClaimsUserStore -Identity cl2 | Set-FASTSearchSecurityClaimsUserStore -Issuer Windows ``` @@ -47,13 +47,15 @@ The Set-FASTSearchSecurityClaimsUserStore cmdlet updates the SecurityContent val ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The user store identity. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -SecurityContent + +> Applicable: FAST Server for SharePoint 2010 + A claims user store object whose property values are used to update another claims user store. ```yaml Type: ClaimsUserStore Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A brief explanation of the user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -95,13 +101,15 @@ Accept wildcard characters: False ``` ### -Issuer + +> Applicable: FAST Server for SharePoint 2010 + The Microsoft SharePoint Server Security Token Service (STS) claims provider that issued the claims. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityDefaultUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityDefaultUserStore.md index ede80ed4f..50690749c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityDefaultUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityDefaultUserStore.md @@ -34,14 +34,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityDefaultUserStore -DefaultUserStoreId win ``` This example sets the default user store to "win". -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$defuserstore | Set-FASTSearchSecurityDefaultUserStore ``` @@ -53,13 +53,15 @@ In this example, the $defuserstoreGeneralSetting was created with this command: ## PARAMETERS ### -DefaultUserStoreId + +> Applicable: FAST Server for SharePoint 2010 + The identity of the user store to set as the default user store. ```yaml Type: String Parameter Sets: ProcessId -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -69,13 +71,15 @@ Accept wildcard characters: False ``` ### -GeneralSetting + +> Applicable: FAST Server for SharePoint 2010 + A DefaultUserStoreSettinginstance whose property values are used for the DefaultUserStoreSetting being updated. ```yaml Type: DefaultUserStoreSetting Parameter Sets: ProcessGeneralSetting -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLogLevel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLogLevel.md index 211247798..35be60f2f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLogLevel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLogLevel.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityLogLevel -DefaultLogLevel debug -IncludeExceptionStack $True ``` This example sets the default log level to the "Debug" level and enables the setting to include the exception stack in the log. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityLogLevel -WarningNameSpaceLogLevel Microsoft ``` @@ -48,13 +48,15 @@ This example sets the log level setting for the "Microsoft" namespace to the "Wa ## PARAMETERS ### -GeneralSetting + +> Applicable: FAST Server for SharePoint 2010 + A LogLevelSetting whose property values are used for the LogLevelSetting being updated. ```yaml Type: LogLevelSetting Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -DebugNameSpaceLogLevel + +> Applicable: FAST Server for SharePoint 2010 + A list of C# namespaces. Any class contained in that namespace logs all messages to the log. @@ -73,8 +78,7 @@ If you specify the same class in more than one name space log level, the log lev ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -DefaultLogLevel + +> Applicable: FAST Server for SharePoint 2010 + Specifies the type of log messages that each class writes to the log, unless the class is contained in a namespace explicitly specified in ErrorLogLevelNameSpaces, WarningLogLevelNameSpaces, InfoLogLevelNameSpaces, and DebugLogLevelNameSpaces. Valid values are: @@ -96,8 +103,7 @@ Valid values are: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -ErrorNameSpaceLogLevel + +> Applicable: FAST Server for SharePoint 2010 + A list of C# namespaces. Any class included in the namespace only logs error messages. @@ -116,8 +125,7 @@ If you specify the same class in more than one namespace log level, the log leve ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -127,14 +135,16 @@ Accept wildcard characters: False ``` ### -IncludeExceptionStack + +> Applicable: FAST Server for SharePoint 2010 + Whether or not to include the exception stack in the log. Set to $True to include the exception stack. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -144,6 +154,9 @@ Accept wildcard characters: False ``` ### -InfoNameSpaceLogLevel + +> Applicable: FAST Server for SharePoint 2010 + A list of C# namespaces. Any class contained in that namespace only logs error, warning, and info messages. @@ -153,8 +166,7 @@ If you specify the same class in more than one namespace log level, the log leve ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -164,6 +176,9 @@ Accept wildcard characters: False ``` ### -WarningNameSpaceLogLevel + +> Applicable: FAST Server for SharePoint 2010 + A list of C# namespaces. Any class included in the namespace only logs error and warning messages. @@ -173,8 +188,7 @@ If you specify the same class in more one than namespace log level, the log leve ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLotusNotesUserStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLotusNotesUserStore.md index ae8d53408..8450af6ee 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLotusNotesUserStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityLotusNotesUserStore.md @@ -32,14 +32,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityLotusNotesUserStore -Identity ln4 -Description "My Lotus user store" ``` This example updates the description of the "ln4" Lotus Notes user store. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityLotusNotesUserStore -Identity ln3 | Set-FASTSearchSecurityLotusNotesUserStore -UseDocumentSecurity $false ``` @@ -52,13 +52,15 @@ The Set-FASTSearchSecurityLotusNotesUserStore command updates the SecurityConten ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + Identity of the Lotus Notes user store to update. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -68,13 +70,15 @@ Accept wildcard characters: False ``` ### -SecurityContent + +> Applicable: FAST Server for SharePoint 2010 + A Lotus Notes user store object whose property values are used for the Lotus Notes user store being updated. ```yaml Type: LotusNotesUserStore Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: FAST Server for SharePoint 2010 + A brief explanation of the user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 2 @@ -100,6 +106,9 @@ Accept wildcard characters: False ``` ### -UseDenyOnDefault + +> Applicable: FAST Server for SharePoint 2010 + If true, support for default access with deny on users/groups is enabled on database level security. You must enable this filter for an inverse security model: first grant access to everyone, and then explicitly deny access to certain groups or users. @@ -107,8 +116,7 @@ You must enable this filter for an inverse security model: first grant access to ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 3 @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -UseDocumentSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, item security is enabled (i.e., the filter contains a item level security condition). If set to false, item level security is ignored; only database level security (and possibly view security) is used. @@ -127,8 +138,7 @@ If items always inherit the ACLs of the database, you can turn off this option. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 4 @@ -138,6 +148,9 @@ Accept wildcard characters: False ``` ### -UseWildcardSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, database access through wildcard group entry (starting with */) is enabled. If set to false, the wildcard check is ignored. @@ -146,8 +159,7 @@ Only normal groups are checked against the database ACL. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 5 @@ -157,6 +169,9 @@ Accept wildcard characters: False ``` ### -UseViewSecurity + +> Applicable: FAST Server for SharePoint 2010 + If true, view security is enabled (i.e., the filter contains a view level security condition). If set to false, view level security is ignored; only database level security (and possibly item security) is used. @@ -166,8 +181,7 @@ If views always inherit the ACLs of the database, or if views are not indexed, y ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 6 @@ -177,13 +191,15 @@ Accept wildcard characters: False ``` ### -AllowPrefix + +> Applicable: FAST Server for SharePoint 2010 + A string value prepended to the document ACL to control which items the user is allowed access to and which items will be returned in the query. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 7 @@ -193,13 +209,15 @@ Accept wildcard characters: False ``` ### -DenyPrefix + +> Applicable: FAST Server for SharePoint 2010 + A string value prepended to the ACL to control which items the user is denied access to and which items are not returned from the query. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 8 @@ -209,6 +227,9 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterHandling + +> Applicable: FAST Server for SharePoint 2010 + Specifies what to do with ACL values that match the NonIndexableCharacterRegExPattern regular expression. Valid values: @@ -220,8 +241,7 @@ Valid values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9 @@ -231,13 +251,15 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterEncodingPrefix + +> Applicable: FAST Server for SharePoint 2010 + If NonIndexableCharacterHandling is set to encodeWithPrefix, this parameter specifies the prefix added to the encoded ACL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 10 @@ -247,14 +269,16 @@ Accept wildcard characters: False ``` ### -NonIndexableCharacterPattern + +> Applicable: FAST Server for SharePoint 2010 + Specifies a regular expression pattern used to detect non-indexable characters in an ACL. Identities matching this regular expression pattern will be processed based on NonIndexableCharacterHandling. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 11 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityPublicFilter.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityPublicFilter.md index 309f3a10e..5237bb099 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityPublicFilter.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityPublicFilter.md @@ -35,14 +35,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityPublicFilter -Filter docacl:unknown ``` This example updates the search security filter that is used to find documents that all users have access to. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` C:\PS>$pubfilter | Set-FASTSearchSecurityPublicFilter ``` @@ -54,13 +54,15 @@ In this example, the $pubfilterGeneralSetting was created with this command: $pu ## PARAMETERS ### -Filter + +> Applicable: FAST Server for SharePoint 2010 + The search security filter that is used to find documents that all users have access to. ```yaml Type: String Parameter Sets: ProcessFilter -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 1 @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -GeneralSetting + +> Applicable: FAST Server for SharePoint 2010 + A PublicFilterSetting whose property values are used for the PublicFilterSetting being updated. ```yaml Type: PublicFilterSetting Parameter Sets: ProcessPipelineSetting -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: 9999 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityRegexAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityRegexAliaser.md index 46cca5a62..c652996e6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityRegexAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityRegexAliaser.md @@ -31,14 +31,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityRegexAliaser -Identity regex1 -OutputUserStoreIds ln2, ln3 ``` This example modifies the output user store ids for the "regex1" regular expression aliaser. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` New-FASTSearchSecurityRegexAliaserPattern -Regex .* -InputPropertyName mail -MapToUsername "\1" | Set-FASTSearchSecurityRegexAliaser -Identity regexalias1 ``` @@ -49,13 +49,15 @@ The regular expression pattern can be used to map the "mail" property of a Micro ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the aliaser to update. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: 1 @@ -65,14 +67,16 @@ Accept wildcard characters: False ``` ### -CaseSensitive + +> Applicable: FAST Server for SharePoint 2010 + Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on case sensitivity matching rules. The default is true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -82,13 +86,15 @@ Accept wildcard characters: False ``` ### -InputUserStoreId + +> Applicable: FAST Server for SharePoint 2010 + The identity of the mapped-from user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -OutputUserStoreIds + +> Applicable: FAST Server for SharePoint 2010 + A comma-separated list of mapped-to user store identities. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Patterns + +> Applicable: FAST Server for SharePoint 2010 + List of RegExAliasPatternMapConfig instances containing the regular expression patterns using for the mapping. Use the New-RegExAliasPatternMapConfig cmdlet to create patterns. @@ -121,8 +132,7 @@ Use the New-RegExAliasPatternMapConfig cmdlet to create patterns. ```yaml Type: System.Collections.Generic.List`1[Microsoft.SharePoint.Search.Extended.Security.Config.RegExAliasPatternMapConfig] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -RegexAliaser + +> Applicable: FAST Server for SharePoint 2010 + A SecurityRegexAliaser object whose property values are used for the SecurityRegexAliaser aliaser being created. ```yaml Type: SecurityRegexAliaser Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -148,13 +160,15 @@ Accept wildcard characters: False ``` ### -UnicodeCaseSensitive + +> Applicable: FAST Server for SharePoint 2010 + Specifies whether the regular expressions patterns defined in the RegExAliasPatternMapConfig list are matched based on Unicode case sensitivity matching rules. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityXMLAliaser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityXMLAliaser.md index c0110b539..a8fc250ac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityXMLAliaser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-FASTSearchSecurityXMLAliaser.md @@ -32,14 +32,14 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Set-FASTSearchSecurityXMLAliaser -Identity xmlalias1 -PathToXMLFile "C:\dev\temp\mapping1.xml" ``` This example uploads and updates the XML mapping for an XML aliaser. -### ---------------EXAMPLE 2----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 2 (FAST Server for SharePoint 2010) ``` Get-FASTSearchSecurityAliaser myxmlalias | Set-FASTSearchSecurityXMLAliaser -OutputUserStoreIds ln2 -InputPropertyName '$PRINCIPAL_REFERENCE_ALIAS' ``` @@ -49,13 +49,15 @@ This example changes the OutputUserStoreIds and InputPropertyName for the XML al ## PARAMETERS ### -Identity + +> Applicable: FAST Server for SharePoint 2010 + The identity of the XML aliaser to update. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: True Position: Named @@ -65,6 +67,9 @@ Accept wildcard characters: False ``` ### -InputPropertyName + +> Applicable: FAST Server for SharePoint 2010 + The user/group property name this regular expression pattern is matched again. The inputPropertyName is one of the following: @@ -83,8 +88,7 @@ Refer to your specific user store for other properties that the user store expos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -94,13 +98,15 @@ Accept wildcard characters: False ``` ### -InputUserStoreId + +> Applicable: FAST Server for SharePoint 2010 + The identity of the mapped-from user store. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -110,13 +116,15 @@ Accept wildcard characters: False ``` ### -OutputUserStoreIds + +> Applicable: FAST Server for SharePoint 2010 + A comma-separated list of mapped-to user store identities. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -126,6 +134,9 @@ Accept wildcard characters: False ``` ### -PathToXMLFile + +> Applicable: FAST Server for SharePoint 2010 + The absolute path to the XML mapping file to upload to the XML aliaser. The path must specify a file accessible to the security manager. @@ -133,8 +144,7 @@ The path must specify a file accessible to the security manager. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -144,13 +154,15 @@ Accept wildcard characters: False ``` ### -XMLAliaser + +> Applicable: FAST Server for SharePoint 2010 + A SecurityXMLAliaserobject whose property values are being updated. ```yaml Type: SecurityXMLAliaser Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServiceApplication.md index 8607c1872..276b48d62 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets global properties of an existing Access Services application in SharePoint Server. - ## SYNTAX ``` @@ -34,18 +33,16 @@ The changes made to the properties by using this cmdlet affect all machines in t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Set-SPAccessServiceApplication -identity "MyAccessService" -RequestDurationMax 100 ``` This example sets the Access Services application named MyAccessService to let requests take up to 100 seconds before they time out. - -### ------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPAccessServiceApplication | Set-SPAccessServiceApplication -SessionsPerUserMax 5 ``` @@ -54,8 +51,7 @@ This example sets every Access Services application in the farm to allow up to f First, every Access Services application is retrieved and then a new value is set by using the `Set-SPAccessServiceApplication` cmdlet. - -### ------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Get-SPAccessServiceApplication | where {$_.RowsMax -gt 50000 } | Set-SPAccessServiceApplication -RowsMax 50000 ``` @@ -64,10 +60,12 @@ This example sets every Access Services application in the farm that allows more First, every Access Services application that has more than 50,000 rows is retrieved and then a new value is set by using the `Set-SPAccessServiceApplication` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Access Services application to update. The type must be a valid name of an Access Services application; for example, AccessSrvApp1; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPAccessServiceApplication object. @@ -75,8 +73,7 @@ The type must be a valid name of an Access Services application; for example, Ac ```yaml Type: SPAccessServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +107,9 @@ Accept wildcard characters: False ``` ### -CacheTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of seconds that a data cache will remain active on Access services with no user activity. Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. @@ -117,8 +119,7 @@ The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +129,9 @@ Accept wildcard characters: False ``` ### -ColumnsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of columns that a list involved in a query can contain, or that the output of the query can contain. The default value is 30. @@ -136,8 +140,7 @@ The type must be an integer in the range of 1 to 255. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -154,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -164,13 +169,15 @@ Accept wildcard characters: False ``` ### -NonRemotableQueriesAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that queries that cannot be sent remotely to the database tier can run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +187,9 @@ Accept wildcard characters: False ``` ### -OrderByMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of Order By clauses in the query. The default value is 4. @@ -188,8 +198,7 @@ The type must be an integer in the range of 1 to 8. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +208,16 @@ Accept wildcard characters: False ``` ### -OuterJoinsAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that left and right outer joins are supported. Inner joins are always supported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +227,9 @@ Accept wildcard characters: False ``` ### -OutputCalculatedColumnsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of calculated columns that can be included in the output as a part of the query. Calculated columns in the underlying SharePoint list are not included. The default value is 10. @@ -225,8 +239,7 @@ The type must be an integer in the range of 1 to 32. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -236,6 +249,9 @@ Accept wildcard characters: False ``` ### -PrivateBytesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum private bytes in megabytes that can be used by Access Services. When set to -1 it defaults to 75 percent of physical memory on the machine. Valid values: -1, no limit, from 1 to any positive integer.The default value is -1. @@ -243,8 +259,7 @@ Valid values: -1, no limit, from 1 to any positive integer.The default value is ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -254,6 +269,9 @@ Accept wildcard characters: False ``` ### -RecordsInTableMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of records allowed for a table in the Access Services application. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 500000. @@ -263,8 +281,7 @@ The type must be the integer -1, or an integer in the range of 1 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -274,6 +291,9 @@ Accept wildcard characters: False ``` ### -RequestDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. The default value is 30. @@ -283,8 +303,7 @@ The type must be the integer -1, or an integer in the range of 1 to 2073600 (24 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,6 +313,9 @@ Accept wildcard characters: False ``` ### -RowsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of rows that a list involved in a query can have, or that the output of the query can have. The default value is 50000. @@ -302,8 +324,7 @@ The type must be an integer in the range of 1 to 200000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -313,6 +334,9 @@ Accept wildcard characters: False ``` ### -SessionMemoryMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum allowable size, in megabytes, of an individual session. Valid values include: 0, disable property, 1 to 4095. The default value is 64. @@ -322,8 +346,7 @@ The type must be the integer 0, or an integer in the range of 1 to 4095. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +356,9 @@ Accept wildcard characters: False ``` ### -SessionsPerAnonymousUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of sessions allowed per user. If this maximum is reached, the oldest session will be deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. @@ -343,8 +369,7 @@ The integer -1, or an integer in the range of 1 to MaxInt ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -354,6 +379,9 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of sessions allowed per user. If this maximum is reached, the oldest session will be deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. @@ -364,8 +392,7 @@ The integer -1, or an integer in the range of 1 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -375,6 +402,9 @@ Accept wildcard characters: False ``` ### -SourcesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of lists that may be used as input to a query at one time. The default value is 8. @@ -383,8 +413,7 @@ The type must be an integer in the range of 1 to 20. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -394,14 +423,16 @@ Accept wildcard characters: False ``` ### -TemplateSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum allowable size in megabytes (MB) allowed for Access templates (.accdt files) uploaded into the solution gallery. Valid values: -1, no limit, from 1 to any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -411,6 +442,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -418,7 +452,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -428,13 +461,15 @@ Accept wildcard characters: False ``` ### -ApplicationLogSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of records for an Access Services Application Log list. Valid valies: -1 to maxint. A value of zero means none is allowed. The default value is 3000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesApplication.md index 6d21eb747..5ea159357 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesApplication.md @@ -13,8 +13,7 @@ ms.reviewer: # Set-SPAccessServicesApplication ## SYNOPSIS -Sets the properties of a Access Services service application. - +Sets the properties of a Access Services service application. ## SYNTAX @@ -28,10 +27,9 @@ Set-SPAccessServicesApplication [-Identity] ## DESCRIPTION Use the `Set-SPAccessServicesApplication` cmdlet to set the properties of an Access Services service application. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = Get-SPAccessServicesApplication Set-SPAccessServicesApplication -Identity $sa -SessionsPerUserMax 50 @@ -39,10 +37,12 @@ Set-SPAccessServicesApplication -Identity $sa -SessionsPerUserMax 50 Sets the maximum number of sessions per user to 50. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -CacheTimeout + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the cache timeout value in seconds. The default is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Access Service service application to update. The type must be a valid GUID or the name of a valid managed metadata service application. @@ -104,8 +110,7 @@ The type must be a valid GUID or the name of a valid managed metadata service ap ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -116,13 +121,14 @@ Accept wildcard characters: False ### -PrivateBytesMax +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum private bytes that can be used by Access Services. The default value is -1 (no limit). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +139,14 @@ Accept wildcard characters: False ### -RecoveryPointObjective +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Not used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -RequestDurationMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the timeout value for requests in seconds. Default is 30. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -SessionsPerAnonymousUserMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the number of sessions per anonymous user. The default is 25. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +192,15 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the number of sessions per user. The default is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +210,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -204,7 +220,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServer.md index 0f4bbf77f..2f0c28787 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets parameters associated with a database server hosting Access Services databases. - ## SYNTAX ### SetAvailableForCreateParameterSet @@ -84,10 +83,9 @@ Set-SPAccessServicesDatabaseServer [-ServiceContext] ## DESCRIPTION Sets parameters associated with a database server hosting Access Services databases allowing you to control database creation, credentials, and failover database servers. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0] $dbsvr = (Get-SPAccessServicesDatabaseServer -ServiceContext $site -DatabaseServerGroup DEFAULT)[0] @@ -95,10 +93,12 @@ Set-SPAccessServicesDatabaseServer -ServiceContext $site -DatabaseServerGroup DE ``` Sets the first database in the database server group named DEFAULT to exclusive mode and disallowing creation of new Access Services database on the selected database server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +110,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +120,15 @@ Accept wildcard characters: False ``` ### -AvailableForCreate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Indicates whether new Access Services databases can be created on the specified SQL Server. ```yaml Type: Boolean Parameter Sets: SetAvailableForCreateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -137,13 +138,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -153,13 +156,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server hosting Access Services databases. ```yaml Type: AccessServicesDatabaseServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -169,13 +174,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Credential object for the database user. Use this parameter if you use SQL Server Authentication. If no database credentials are provided, Windows authentication is used. ```yaml Type: PSCredential Parameter Sets: SetCredentialsParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,13 +192,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the Access Services database server group containing the SQL Server object to set. ```yaml Type: AccessServicesDatabaseServerGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -201,13 +210,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server hosting Access Services databases. ```yaml Type: String Parameter Sets: SetCredentialsParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -217,13 +228,15 @@ Accept wildcard characters: False ``` ### -Encrypt + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Encrypts the database server connection. ```yaml Type: Boolean Parameter Sets: SetEncryptParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -233,13 +246,15 @@ Accept wildcard characters: False ``` ### -Exclusive + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the database server to exclusive mode. No further Access Services databases are allowed to be created on the database server. ```yaml Type: Boolean Parameter Sets: SetAvailableForCreateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -249,13 +264,15 @@ Accept wildcard characters: False ``` ### -Failover + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables or disables failover for the Access Services database server. ```yaml Type: Boolean Parameter Sets: SetFailoverParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -265,13 +282,15 @@ Accept wildcard characters: False ``` ### -SecondaryDatabaseServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the failover database server name. ```yaml Type: String Parameter Sets: SetSecondaryDatabaseServerNameParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -281,13 +300,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -297,13 +318,15 @@ Accept wildcard characters: False ``` ### -TrustServerCertificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust. ```yaml Type: Boolean Parameter Sets: SetEncryptParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -313,13 +336,15 @@ Accept wildcard characters: False ``` ### -UserDomain + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the user domain for the specified database server. ```yaml Type: String Parameter Sets: SetUserDomainParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -329,6 +354,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -336,7 +364,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -346,10 +373,12 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the database server state. Valid values: - - Active - Locked @@ -359,9 +388,8 @@ Valid values: ```yaml Type: DatabaseServerStates Parameter Sets: SetServerStateParameterSet -Aliases: +Aliases: Accepted values: Active, Locked, Reserved -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -371,6 +399,9 @@ Accept wildcard characters: False ``` ### -StateOwner + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the state owner. Valid values: @@ -382,9 +413,8 @@ Valid values: ```yaml Type: ServerStateOwner Parameter Sets: SetServerStateParameterSet -Aliases: +Aliases: Accepted values: NoOwner, TenantMove -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServerGroupMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServerGroupMapping.md index 734931c02..a68d37b62 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServerGroupMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAccessServicesDatabaseServerGroupMapping.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets or creates the Access Services database server group mapping. - ## SYNTAX ### ClearDatabaseServerGroupMappingParameterSetName @@ -38,14 +37,14 @@ This cmdlet allows you to set the database server group to package source mappin ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` $site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0] Set-SPAccessServicesDatabaseServerGroupMapping -ServiceContext $site -DatabaseServiceGroup GROUP2 ``` Creates an Access Services database group named GROUP2. -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` $site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0] Set-SPAccessServicesDatabaseServerGroupMapping -ServiceContext $site -DatabaseServiceGroup GROUP2 -CorporateCatalog @@ -56,6 +55,9 @@ Sets the database group named GROUP2 associating the group with packages from th ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -ClearMapping + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Clears the database group mapping. ```yaml Type: SwitchParameter Parameter Sets: ClearDatabaseServerGroupMappingParameterSetName -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -CorporateCatalog + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the database server group with packages uploaded to the corporate catalog (SharePoint Add-ins). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +133,15 @@ Accept wildcard characters: False ``` ### -DatabaseServerGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the database server group to set or create. ```yaml Type: AccessServicesDatabaseServerGroupPipeBind Parameter Sets: SetDatabaseServerGroupMappingParameter -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -142,13 +151,15 @@ Accept wildcard characters: False ``` ### -DeveloperSite + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the database server group with packages that came from the Developer Site. A Developer Site is one type of SharePoint template, intended as a site for developers to build, test and publish Office Add-ins. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -ObjectModel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the database server group with packages uploaded via the server-side object model. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,13 +187,15 @@ Accept wildcard characters: False ``` ### -RemoteObjectModel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the database server group with packages that are uploaded via the client-side object model. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -190,13 +205,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -206,13 +223,15 @@ Accept wildcard characters: False ``` ### -StoreFront + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the SharePoint Marketplace with the database server group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +241,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -229,7 +251,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAlternateURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAlternateURL.md index 5bd2a185d..86c2921dd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAlternateURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAlternateURL.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the specified alternate URL. - ## SYNTAX ``` @@ -29,44 +28,42 @@ This cmdlet can be used to change only the zone of internal URLs and cannot be u For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Set-SPAlternateURL -Identity https://www.contoso.com -Zone "Internet" ``` This example changes the zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Set-SPAlternateURL -Identity https://www.contoso.com -Url https://sharepoint.contoso.com -Zone "Default" ``` This example changes the URL and zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ``` Get-SPAlternateURL https://www.contoso.com | Set-SPAlternateURL -Zone "Internet" ``` This example changes the zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 4------------------ +### EXAMPLE 4 ``` Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Set-SPAlternateURL -Zone "Intranet" ``` This example changes the zone of the alternate URL for the specified Web application from Extranet to Intranet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the alternate URL to change. The type must be a valid URL, in the form https://server_name/WebApplication/site, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -74,8 +71,7 @@ The type must be a valid URL, in the form https://server_name/WebApplication/sit ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -85,13 +81,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new alternate URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +99,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the supplied alternate URL as one of the five zones. The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom. @@ -108,8 +109,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +133,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -165,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAcquisitionConfiguration.md index 7d52b7910..9c35a8296 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAcquisitionConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAcquisitionConfiguration.md @@ -36,35 +36,34 @@ Use the Set-SPAppAcquisitionConfiguration cmdlet to set app acquisition settings For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SPAppAcquisitionConfiguration -WebApplication https://localhost -Enable:$false ``` This example disabled app purchases for the specified Web Application. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Set-SPAppAcquisitionConfiguration -SiteSubscription https://localhost/sites/SharePointOnlineAdmin1 -Enable:$false ``` This example disables app purchases for the specified tenant. - ## PARAMETERS ### -Enable -Specifies whether acquisition is enabled or disabled. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether acquisition is enabled or disabled. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,14 +73,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription -Specifies the site collection for which to set app acquisition settings. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the site collection for which to set app acquisition settings. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,16 +91,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,14 +111,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,14 +129,15 @@ Accept wildcard characters: False ``` ### -WebApplication -Specifies the web application for which acquisitions settings are to be set. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the web application for which acquisitions settings are to be set. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -144,15 +147,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAutoProvisionConnection.md index a5903e35e..35427e573 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAutoProvisionConnection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppAutoProvisionConnection.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets provision connection settings for an app. - ## SYNTAX ### WebHostEndPoint @@ -54,18 +53,16 @@ Use the `Set-SPAppAutoProvisionConnection` cmdlet to set provision connection se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SpAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username ``` This example configures remote web host to be used provision apps that use this functionality for the default site subscription server on https://SPremotewebhost. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` C:\PS>$subscription = Get-SPSiteSubscription https://Contoso.com @@ -74,33 +71,32 @@ Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https:/ This example configures remote web host to be used provision apps that use this functionality for the site subscription of Contoso.com site to server on https://SPremotewebhost. - -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost ``` This example updates the endpoint of the already configured remote web host server https://SPRemotewebhost for the default site subscription. - -### --------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ``` Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -Remove ``` This example removes the remote web host configuration for the default site subscription. - ## PARAMETERS ### -ConnectionType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection type to provision. ```yaml Type: ConnectionTypes Parameter Sets: WebHostEndPoint, WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -110,13 +106,15 @@ Accept wildcard characters: False ``` ### -EndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the end point of the provision connection. ```yaml Type: String Parameter Sets: WebHostEndPoint, WebHostSetup -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -126,13 +124,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the provision connection. ```yaml Type: String Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -142,13 +142,15 @@ Accept wildcard characters: False ``` ### -Remove + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the auto provision connection of the app. ```yaml Type: SwitchParameter Parameter Sets: Remove -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -158,13 +160,15 @@ Accept wildcard characters: False ``` ### -Username + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name of the connection. ```yaml Type: String Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -174,6 +178,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -185,8 +192,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,13 +202,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for which the provision connection is to be associated. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDisablingConfiguration.md index fa246742b..7b58a1616 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDisablingConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDisablingConfiguration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the disable list sync state for an app. - ## SYNTAX ``` @@ -28,28 +27,27 @@ Use the Set-SPAppDisablingConfiguration cmdlet to set the disabled sync list sta For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPAppDisablingConfiguration ``` This example sets the disable sync state for apps. - ## PARAMETERS ### -Enable -Specifies whether to enable or disable an entry from the list. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether to enable or disable an entry from the list. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,16 +57,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,14 +77,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -95,15 +95,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDomain.md index 0bd3f1855..665e7ebca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppDomain.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the domain used to host apps. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Set-SPAppDomain` cmdlet to set the domain used to host apps in the farm For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPAppDomain -Domain apps.contoso.com ``` @@ -39,17 +37,18 @@ Set-SPAppDomain -Domain apps.contoso.com This example sets the app domain to apps.contoso.com. All apps in the farm will be hosted in the apps.contoso.com domain. - ## PARAMETERS ### -AppDomain + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the domain to be used for apps. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppHostingQuotaConfiguration.md index d0b40b8eb..e6a37b119 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppHostingQuotaConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppHostingQuotaConfiguration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets hosting quotas for an app. - ## SYNTAX ``` @@ -29,36 +28,34 @@ Use the Set-SPAppHostingQuotaConfiguration cmdlet to set hosting quotas for a sp For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ----------------EXAMPLE 1---------- +### EXAMPLE 1 ``` Set-SPAppHostingQuotaConfiguration -Identity 586d4a32-98c3-42ce-80be-3c76c10c250c -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 ``` This example sets hosting Quotas for the SiteSubscriptionId "586d4a32-98c3-42ce-80be-3c76c10c250c" with hosted appinstance limit as 50 and hosted apps licenses assigned as 25. - -### ----------------EXAMPLE 2---------- +### EXAMPLE 2 ``` Get-SPSiteSubscription | Set-SPAppHostingQuotaConfiguration -Identity $_ -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 ``` This example sets hosting Quotas for all SiteSubscriptions in the farm with hosted apps limit as 50 and hosted apps licenses assigned as 25. - ## PARAMETERS ### -AppHostingLicenseQuota -Specifies the app licensing quota. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the app licensing quota. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -68,13 +65,15 @@ Accept wildcard characters: False ``` ### -AppInstanceCountQuota + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number instances of an app. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -84,16 +83,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +103,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -120,15 +121,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -138,13 +140,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Site Subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppManagementDeploymentId.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppManagementDeploymentId.md index dd601b249..5f73bae7a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppManagementDeploymentId.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppManagementDeploymentId.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the identifier of the farm or tenant used by the Office Marketplace to issue App licenses. - ## SYNTAX ``` @@ -30,10 +29,9 @@ To ensure you do not lose rights to the use of all Apps you have purchased on th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ``` $sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa @@ -41,8 +39,7 @@ Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24B This example sets the deployment identifier of the current farm to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ``` $sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} Get-SPSiteSubscription | where{$_.Id -eq "88f16a50-0530-4f3f-b749-24ef0b30d685"} | Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa @@ -50,17 +47,18 @@ Get-SPSiteSubscription | where{$_.Id -eq "88f16a50-0530-4f3f-b749-24ef0b30d685"} This example sets the deployment identifier of the tenant with the site subscription identifier 88f16a50-0530-4f3f-b749-24ef0b30d685 to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - ## PARAMETERS ### -AppManagementServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app management service application object that is running on the farm. ```yaml Type: AppManagementServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -DeploymentId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the deployment identifier value for the tenant. This parameter works in conjunction with the value that is defined with Identity parameter. If Identity parameter is omitted, then it is assumed that this deployment identifier value belongs to the farm. @@ -77,8 +78,7 @@ If Identity parameter is omitted, then it is assumed that this deployment identi ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +102,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,6 +131,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Identifies the site subscription object representing the tenant to which the DeploymentId parameter is to be assigned. If the Identity parameter is omitted, it is assumed that the deployment identifier belongs to the farm. @@ -134,7 +141,6 @@ If the Identity parameter is omitted, it is assumed that the deployment identifi Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) Aliases: Subscription -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -144,6 +150,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppPrincipalPermission.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppPrincipalPermission.md index 2984ddc48..7e1786202 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppPrincipalPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppPrincipalPermission.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the permissions on a given app principal. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Use the `Set-SPAppPrincipalPermission` cmdlet to set the permissions on a given For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ``` $clientID = "11111111-2222-3333-4444-555555555555" $site = Get-SPSite https://siteUrl @@ -48,13 +46,15 @@ This example sets the App Principal permission to Manage with a scope of Site. ## PARAMETERS ### -AppPrincipal + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the AppPrincipal object. ```yaml Type: SPAppPrincipal Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,6 +64,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the permission level for the principal object. The value is any of the following levels: @@ -79,8 +82,7 @@ The value is any of the following levels: ```yaml Type: SPCmdletAppPrincipalPermissionKind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope to which to apply the principal permission. The value is any of the following scopes: @@ -103,8 +108,7 @@ The value is any of the following scopes: ```yaml Type: SPCmdletAppPrincipalPermissionScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site (that is, SPWeb object) that the AppPrincipalPermission is being set.a ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -141,8 +150,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +160,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -169,6 +179,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -186,6 +198,9 @@ Accept wildcard characters: False ``` ### -EnableAppOnlyPolicy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the app only policy is turned on for the app principal. The valid values are True and False. The default value is False. @@ -193,8 +208,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppScaleProfile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppScaleProfile.md index d912fd3a4..2bce2589b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppScaleProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppScaleProfile.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets settings for the app profile. - ## SYNTAX ``` @@ -28,20 +27,21 @@ Use the `Set-SPAppScaleProfile` cmdlet to set settings for an app profile. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE----------- +### EXAMPLE ``` Set-SPAppScaleProfile -MaxDatabaseSize "2 GB" -RemoteWebSiteInstanceCount 1 ``` This example sets the farm level app scale profile. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,13 +63,15 @@ Accept wildcard characters: False ``` ### -MaxDatabaseSize + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database size of the app profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -RemoteWebSiteInstanceCount + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether a remote site can access the profilefrom. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteDomain.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteDomain.md index 5f365afa5..d4de5c5e9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteDomain.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteDomain.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates or changes the URL of any installed app. - ## SYNTAX ``` @@ -26,28 +25,27 @@ Set-SPAppSiteDomain -Site [-AssignmentCollection Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the SPSite object or the GUID of the SPSite or the URL of the SPSite. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -57,16 +55,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,14 +75,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -93,15 +93,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteSubscriptionName.md index 1bcb7ead7..5cbc1beb0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteSubscriptionName.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppSiteSubscriptionName.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets or changes the name for the specified site subscription. - ## SYNTAX ``` @@ -28,28 +27,28 @@ Use the `Set-SPAppSiteSubscriptionName` cmdlet to set or change the name for a s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ``` Set-SPAppSiteSubscriptionName -Name Contoso ``` This example sets the name of the default site subscription to "Contoso". - -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ``` Set-SPAppSiteSubscriptionName -Name Contoso -SiteSubscription https://www.contoso.com ``` This example changes the name of the site subscription for SPSite from https://www.contoso.com to "Contoso". - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name for the site subscription. Each site subscription must have a unique name. @@ -58,8 +57,7 @@ The name is used in part to determine the domain that apps for SharePoint are in ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +101,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,14 +110,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The site subscription name is recorded in other databases in the SharePoint farm. In cases such as disaster recovery or restore of the SharePoint farm, the Force parameter can be specified to ensure that the site subscription name has been propagated appropriately throughout the SharePoint farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +129,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. If this parameter is not specified, then the default site subscription is used. All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. @@ -132,8 +139,7 @@ All SharePoint SPSites are members of the default site subscription if they have ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStateUpdateInterval.md index a08e04696..b639afe26 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStateUpdateInterval.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the interval in hours between updates of the app state update job. - ## SYNTAX ``` @@ -29,28 +28,28 @@ The app state update job updates the app states, including app updates, in Share For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ``` Set-SPAppStateUpdateInterval -AppStateSyncHours 24 -FastAppRevocationHours 6 ``` This example sets the app state update interval to 24 hours and the fast app revocation interval to 6 hours. - ## PARAMETERS ### -AppStateSyncHours + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the interval in hours between updates of the app states. Values are 1 to 24 inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,14 +59,16 @@ Accept wildcard characters: False ``` ### -FastAppRevocationHours + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the interval in hours between checks of the list of revoked apps in the SharePoint Store. If the list of revoked apps has changed from the last time, the app states are updated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreConfiguration.md index ec0d37cc3..2b7f2f562 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreConfiguration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets SharePoint Store settings for an app. - ## SYNTAX ``` @@ -28,25 +27,23 @@ Use the Set-SPAppStoreConfiguration cmdlet to set SharePoint Store settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SPAppStoreConfiguration -Url https://office.microsoft.com -Enable $true ``` This example sets the URL to the Office.com server. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Set-SPAppStoreConfiguration -Enable $false ``` This example turns off the SharePoint Store. -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Set-SPAppStoreConfiguration -Enable $true ``` @@ -56,16 +53,17 @@ This example turns on the SharePoint Store. ## PARAMETERS ### -Url + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the app for which to set SharePoint Store settings. The SharePoint store value should not be changed unless instructed by a Microsoft representative. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -75,16 +73,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,14 +93,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -111,15 +111,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -129,6 +130,9 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the Office Store services lets third- party add-ins to be found or downloaded. This is intended for administrators to disable discovery and downloads of third-party add-ins on their SharePoint tenants and site collections. @@ -140,8 +144,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreWebServiceConfiguration.md index 41b0e6b6c..d6f1c79a9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreWebServiceConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAppStoreWebServiceConfiguration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a SharePoint Store app. - ## SYNTAX ``` @@ -30,10 +29,9 @@ This cmdlet is not intended for the ITPro audience. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPAppStoreWebServiceConfiguration -Client=SP -ProxyVersion=16.1 ``` @@ -43,6 +41,9 @@ This example set the product type and version for a SharePoint Store app. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -50,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -61,13 +61,15 @@ Accept wildcard characters: False ``` ### -Client + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the client value of the SharePoint Store app. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -93,13 +97,15 @@ Accept wildcard characters: False ``` ### -ProxyVersion + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy version value of the SharePoint Store app. ```yaml Type: Version Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -116,7 +125,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPApplicationCredentialKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPApplicationCredentialKey.md index ec121a8ae..90f799b8f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPApplicationCredentialKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPApplicationCredentialKey.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the application credential key on the local server. - ## SYNTAX ``` @@ -23,7 +22,6 @@ Set-SPApplicationCredentialKey [-Password] [-AssignmentCollection [-WhatIf] [-Confirm] [] ``` - ## DESCRIPTION Use the **Set-SPApplicationCredentialKey** cmdlet to set the application credential key on the local server, which is used by certain features to encrypt and decrypt passwords. @@ -31,7 +29,7 @@ The application credential key must be identical on each server in the farm wher ## EXAMPLES -### EXAMPLE +### EXAMPLE ```powershell $key = ConvertTo-SecureString -String "New Password" -AsPlainText -Force Set-SPApplicationCredentialKey -Password $key @@ -42,6 +40,9 @@ This example sets the application credential key on the local server to "New Pas ## PARAMETERS ### -Password + +> Applicable: SharePoint Server 2019 + Specifies the application credential key. Avoid reusing the farm passphrase or service account passwords for the application credential key. @@ -49,7 +50,7 @@ Avoid reusing the farm passphrase or service account passwords for the applicati Type: SecureString Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2019 + Required: True Position: 1 Default value: None @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,7 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -78,13 +82,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -93,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -100,7 +110,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -112,6 +122,5 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Remove-SPApplicationCredentialKey](Remove-SPApplicationCredentialKey.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAuthenticationRealm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAuthenticationRealm.md index f69947d7e..2a3165f7a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAuthenticationRealm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPAuthenticationRealm.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the authentication realm. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Set-SPAuthenticationRealm` cmdlet to set the authentication realm at th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $c = Get-SPServiceContext -Site "https://" Set-SPAuthenticationRealm -ServiceContext $c -Realm "t686d436-9f16-42db-09b7-cb578e110ccd" @@ -39,10 +37,12 @@ Set-SPAuthenticationRealm -ServiceContext $c -Realm "t686d436-9f16-42db-09b7-cb5 This example sets the authentication realm as specified by the realm parameter. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -72,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the realm to be set. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,14 +101,16 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service context for which the realm needs to be set. For example, $root.web. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsBlock.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsBlock.md index 6c1244e0e..c1c78bd0b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsBlock.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsBlock.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets Bing maps to blocked status. - ## SYNTAX ``` @@ -31,27 +30,27 @@ Use a value of 1 to block in all locales. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPBingMapsBlock 1 ``` This example displays how to block Bing Maps in all locales for the farm. - ## PARAMETERS ### -BlockBingMapsInAllLocales + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether Bing Maps are blocked in all locales. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsKey.md index 184ee38f2..bf5ffc0a8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBingMapsKey.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the Bing Maps key. - ## SYNTAX ``` @@ -30,27 +29,27 @@ For additional information about Bing Keys, see Bing Maps Account Center (https: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPBingMapsKey -BingKey ``` This example sets the key that is used by Bing Maps. - ## PARAMETERS ### -BingKey + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Bing Maps key to set. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBrowserCustomerExperienceImprovementProgram.md index 6eea24a0a..da94a0769 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBrowserCustomerExperienceImprovementProgram.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBrowserCustomerExperienceImprovementProgram.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Turns on or off the browser Customer Experience Improvement Program. - ## SYNTAX ### Farm @@ -45,43 +44,41 @@ The `Set-SPBrowserCustomerExperienceImprovementProgram` cmdlet turns on or off t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable ``` This example turns on the browser Customer Experience Improvement Program for the farm. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable:$False ``` This example turns off the browser Customer Experience Improvement Program for the farm. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` Set-SPWebApplication https://MyOfficeApp1 | Get- SPBrowserCustomerExperienceImprovementProgram -Enable ``` This example turns on the browser Customer Experience Improvement Program for the Web application, MyOfficeApp1. - ## PARAMETERS ### -Farm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill Farm Description}} ```yaml Type: SwitchParameter Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +88,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the Customer Experience Improvement Program opt-in state for the specified site subscription. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. @@ -98,8 +98,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +108,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the Customer Experience Improvement Program opt-in state for the specified SharePoint Web application. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -116,8 +118,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -127,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +142,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +162,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,14 +171,16 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on the browser Customer Experience Improvement Program. The default value is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +190,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -190,7 +200,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogEntityNotificationWeb.md index 39f80aef0..0b5c6954c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogEntityNotificationWeb.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the entity notification site. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use the `Set-SPBusinessDataCatalogEntityNotificationWeb` cmdlet to sets the enti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPBusinessDataCatalogEntityNotificationWeb -Web "https://contoso" ``` This example sets https://contoso as the entity notification site for the service context of the site at https://contoso. - ## PARAMETERS ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site to be set as the entity notification site for its own service context. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogMetadataObject.md index e8e0ed699..6617bb308 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogMetadataObject.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ### Display @@ -48,10 +47,9 @@ The `Set-SPBusinessDataCatalogMetadataObject` cmdlet sets the value of a propert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $obj = Get-SPBusinessDataCatalogMetadataObject -Namespace "ContosoDatabase" -Name "ContosoDatabase" -BdcObjectType "LobSystemInstance" -ServiceContext http://contoso Set-SPBusinessDataCatalogMetadataObject -Identity $obj -PropertyName "ShowInSearchUI" -PropertyValue "True" @@ -60,17 +58,18 @@ Set-SPBusinessDataCatalogMetadataObject -Identity $obj -PropertyName "ShowInSear This example creates a property on the LobSystemInstance (External System Instance) of name ContosoDatabase. The property has the name ShowInSearchUI and a value of True. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity Metadata Store metadata object to update. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,13 +122,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the Business Data Connectivity Metadata Store metadata object. ```yaml Type: String Parameter Sets: Display -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +140,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the property to update. ```yaml Type: String Parameter Sets: NameValue, NameRemove -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +158,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the new value of the property specified in the PropertyName parameter. ```yaml Type: PSObject Parameter Sets: NameValue -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +176,15 @@ Accept wildcard characters: False ``` ### -Remove + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the property specified in the PropertyName parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom environment settings model slice for which the property applies. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -190,8 +204,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +214,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -208,7 +224,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogServiceApplication.md index 8ea60a9ca..22e4d036d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets global properties for a Business Data Connectivity service application in the farm. - ## SYNTAX ``` @@ -31,10 +30,9 @@ The `Set-SPBusinessDataCatalogServiceApplication` cmdlet sets global properties For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Business Data Connectivity Service Application'} Set-SPBusinessDataCatalogServiceApplication -Identity $sa -FailoverDatabaseServer "CONTOSO\Backup" @@ -42,17 +40,18 @@ Set-SPBusinessDataCatalogServiceApplication -Identity $sa -FailoverDatabaseServe This example sets the failover database server to CONTOSO\Backup for the given service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS application pool to use for the new Business Data Connectivity service application. ```yaml Type: SPIisWebServiceApplicationPool Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -69,8 +71,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Business Data Connectivity database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -87,8 +91,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -106,8 +112,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Business Data Connectivity database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -124,8 +132,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the catalog database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -143,8 +153,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -161,8 +173,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +183,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Business Data Connectivity service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -188,13 +201,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a display name for the new Business Data Connectivity service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +219,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Business Data Connectivity service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -220,6 +237,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -227,7 +247,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -237,6 +256,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -244,7 +266,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -254,13 +275,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogThrottleConfig.md index d589453b8..372b7d7be 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogThrottleConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPBusinessDataCatalogThrottleConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the throttling configuration for a Business Data Connectivity Service application. - ## SYNTAX ### MaxDefault @@ -39,27 +38,27 @@ The `Set-SPBusinessDataCatalogThrottleConfig` cmdlet sets the throttling configu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy | Set-SPBusinessDataCatalogThrottleConfig -Maximum 1000000000 -Default 500000 ``` This example sets the database item throttling to values of 1000000000 maximum and 500000 default for the given service application. - ## PARAMETERS ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the default setting of the throttle configuration. ```yaml Type: Int32 Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -69,13 +68,15 @@ Accept wildcard characters: False ``` ### -Enforced + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the throttle configuration setting cannot be overridden. ```yaml Type: SwitchParameter Parameter Sets: Enforcement -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the throttle configuration to update. ```yaml Type: ThrottleConfig Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -Maximum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum value of the throttling configuration setting. ```yaml Type: Int32 Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -128,8 +136,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCentralAdministration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCentralAdministration.md index 89a84e280..e8d8c7b20 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCentralAdministration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCentralAdministration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the port for the SharePoint Central Administration Web site. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Set-SPCentralAdministration` cmdlet sets the port for the Central Administr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPCentralAdministration -Port 8282 ``` This example sets the port for the Central Administration web application on the local farm to 8282. - ## PARAMETERS ### -Port + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the administration port for the Central Administration site. The type must be a valid port number; for example, 8080. @@ -49,8 +49,7 @@ The type must be a valid port number; for example, 8080. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Enables Secure Socket Layer (SSL) encryption for the specified port. If you choose to use SSL, you must assign a server certificate to the Central Administration IIS web site by using the IIS administration tools. The Central Administration web application won't be accessible until you do this. The default value is False. @@ -125,8 +133,7 @@ If this parameter is omitted or set to False the Central Administration site wil ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPClaimProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPClaimProvider.md index 92f586f9a..cbb859426 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPClaimProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPClaimProvider.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates registration of a claims provider. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Set-SPClaimProvider` cmdlet updates registration of a claims provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" ``` This example turns off the specified claim provider. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claim provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the claim provider applies to all Web applications and zones. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,13 +101,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on the claim provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDatabase.md index 7abc31f33..6473a2304 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets global properties of a SharePoint content database. - ## SYNTAX ``` @@ -29,28 +28,28 @@ The `Set-SPContentDatabase` cmdlet sets global properties of a SharePoint conten For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE 1--------------- +### EXAMPLE 1 ``` Get-SPContentDatabase https://contoso.com | Set-SPContentDatabase -MaxSiteCount 1 ``` This example sets the MaxSiteCount for the content database that contains contoso.com to 1. - -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ``` Get-SPContentDatabase -WebApplication https://sitename | Set-SPContentDatabase -WarningSiteCount $null ``` This example clears the WarningSiteCount for all databases in the sitename Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -58,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +101,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,6 +110,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of site collections that this database can host. The type must be a positive integer. @@ -116,8 +121,7 @@ Set to $null to clear this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +131,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the status of the SQL Server database. Set this parameter to Online to make the database available to host new sites. Set this parameter to Disabled to make the database unavailable to host new sites. @@ -136,8 +143,7 @@ The type must be either of the following: Online or Disabled ```yaml Type: SPObjectStatus Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +153,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of site collections that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -155,8 +164,7 @@ Set to $null to clear this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +184,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -183,13 +193,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the mirror server for failover. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentJob.md index ee46680ad..795bd5a39 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentJob.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a content deployment job. - ## SYNTAX ``` @@ -32,20 +31,21 @@ The `Set-SPContentDeploymentJob` cmdlet sets the properties of a content deploym For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPContentDeploymentJob "Job 1" | Set-SPContentDeploymentJob -Schedule "hourly between 0 and 59" -ScheduleEnabled:$true ``` This example sets the deployment job called Job 1 to run hourly. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment job to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description for the content deployment job. The name can be a maximum of 4096 alphanumeric characters. @@ -111,8 +117,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. The type must be a list of valid e-mail addresses. @@ -129,8 +137,7 @@ The type must be a list of valid e-mail addresses. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -EmailNotifications + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies how e-mail notifications are sent about this ContentDeploymentJob object. The type must be one of the following: @@ -153,8 +163,7 @@ The type must be one of the following: ```yaml Type: ContentDeploymentNotificationSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -HostingSupportEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables special hosting behavior. The default value is False. @@ -174,8 +186,7 @@ Therefore, when the HostingSupportEnabled parameter is set to True, the hoster c ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,13 +196,15 @@ Accept wildcard characters: False ``` ### -IncrementalEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only incremental changes are deployed to the destination site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +214,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the new content deployment job. The type must be a valid name of a content deployment job; for example, DeployJob1. @@ -208,8 +224,7 @@ The type must be a valid name of a content deployment job; for example, DeployJo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the schedule for the deployment job. The type must be a valid SPSchedule object. @@ -226,8 +244,7 @@ The type must be a valid SPSchedule object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +254,16 @@ Accept wildcard characters: False ``` ### -ScheduleEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables the schedule for the deployment job. If the schedule is not enabled, the job can be run manually only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -254,6 +273,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the scope of the deployment job. SPSite objects that are passed in must exist in the current path of the source site collection. The default scope is the entire site collection. @@ -264,8 +286,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +296,9 @@ Accept wildcard characters: False ``` ### -SqlSnapshotSetting + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Backs up the SharePoint Foundation content database by using SQL Server. The type must be one of the following values: None or CreateNew. @@ -282,8 +306,7 @@ The type must be one of the following values: None or CreateNew. ```yaml Type: ContentDeploymentSqlSnapshotSetting Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -293,6 +316,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -300,7 +326,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentPath.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentPath.md index d880c69a1..f67b56b0e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPContentDeploymentPath.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a content deployment path. - ## SYNTAX ``` @@ -32,20 +31,21 @@ The `Set-SPContentDeploymentPath` cmdlet sets the properties of a content deploy For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Get-SPContentDeploymentPath "Path 1" | Set-SPContentDeploymentPath -PathEnabled:$false ``` This example sets the deployment path Path 1 to be disabled. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment path to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. The type must be one of the following values: WindowsAuth or BasicAuth. @@ -93,8 +97,7 @@ The type must be one of the following values: WindowsAuth or BasicAuth. ```yaml Type: PathAuthenticationOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +107,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on compression during the export. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -DeploySecurityInformation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user and group information to include during the export operation for this content deployment path. The default value is All. @@ -131,8 +139,7 @@ No user information defined in the DAP or LDAP servers is included. ```yaml Type: SPIncludeSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -DeployUserNamesEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specify to enable event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the description for the content deployment path. The description can contain a maximum of 4096 alphanumeric characters. @@ -166,8 +178,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -DestinationCentralAdministrationURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Central Administration URL for the destination farm. The type must be a valid URL, in the form http://server_name. @@ -184,8 +198,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -195,13 +208,15 @@ Accept wildcard characters: False ``` ### -EventReceiversEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -211,6 +226,9 @@ Accept wildcard characters: False ``` ### -KeepTemporaryFilesOptions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that temporary files are kept after content deployment is finished. The type must be one of the following values: Never, Always, or OnFailure. @@ -218,8 +236,7 @@ The type must be one of the following values: Never, Always, or OnFailure. ```yaml Type: TemporaryFilesOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +246,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the content deployment path. The type must be a valid name of a content deployment path; for example, DeploymentPath1. @@ -236,8 +256,7 @@ The type must be a valid name of a content deployment path; for example, Deploym ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +266,9 @@ Accept wildcard characters: False ``` ### -PathAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user ID that is an administrator on the Central Administration page on the destination farm. The type must be a valid SharePoint user. @@ -254,8 +276,7 @@ The type must be a valid SharePoint user. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -265,13 +286,15 @@ Accept wildcard characters: False ``` ### -PathEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables the content deployment path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -281,6 +304,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -288,7 +314,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -298,13 +323,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCustomLayoutsPage.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCustomLayoutsPage.md index d1e57dec7..ec098ac07 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCustomLayoutsPage.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPCustomLayoutsPage.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Maps a new path for a custom layout page. - ## SYNTAX ### CustomPage @@ -42,20 +41,21 @@ To remove the mapping for a custom layouts page, use the Reset parameter instead For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPCustomLayoutsPage -Identity AccessDenied -RelativePath "/_layouts/custompages/myaccessdenied.aspx" -WebApplication "https://server_name/mywebapp" ``` This example maps the specified path for the AccessDenied layout page in the Web application "https://server_name/mywebapp". - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the custom layout page to set. The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. @@ -63,8 +63,7 @@ The type must be one of the following: None, AccessDenied, Confirmation, Error, ```yaml Type: SPCustomPage Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,6 +73,9 @@ Accept wildcard characters: False ``` ### -RelativePath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of the custom layout page. The type must be a valid path of a layout page, in the form _layouts/custompages/myaccessdenied.aspx. @@ -81,8 +83,7 @@ The type must be a valid path of a layout page, in the form _layouts/custompages ```yaml Type: String Parameter Sets: CustomPage -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -92,13 +93,15 @@ Accept wildcard characters: False ``` ### -Reset + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Resets the mapping of a custom layouts page. ```yaml Type: SwitchParameter Parameter Sets: ResetCustomPage -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web application that contains the custom layout page. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -115,8 +121,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -137,8 +145,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +165,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +184,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDataConnectionFile.md index 1c89cd04c..eabe856c1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDataConnectionFile.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a data connection file. - ## SYNTAX ``` @@ -29,44 +28,42 @@ The `Set-SPDataConnectionFile` cmdlet sets the properties of the data connection For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Set-SPDataConnectionFile -Identity "sample.udcx" -Category "Temp" ``` This example updates the Category of the specified .udcx file. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Set-SPDataConnectionFile -Identity "sample.udcx" -DisplayName "NewDisplayName" ``` This example updates the DisplayName of the specified .udcx file. - -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Sample.udcx" | Set-SPDataConnectionFile -Category "Temp" ``` This example updates the Category of the specified .udcx file. - -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ``` Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} | Set-SPDataConnectionFile -Category "Category2" ``` This example updates the Category field for the collection of .udcx files that are returned from a query used by the `Get-SPDataConnectionFile` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the data connection file to update. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -74,8 +71,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -85,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +105,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets an arbitrary category on the file which can be used to group the files. The category name can have a maximum of 255 characters. @@ -115,8 +116,7 @@ The type must be a valid string value; for example, Category1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -133,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -143,6 +145,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the description for the data connection file. The name can be a maximum of 4096 alphanumeric characters. @@ -151,8 +156,7 @@ The type must be a valid string; for example, Description of my universal data c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +166,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name that describes the data connection file. The name can have a maximum of 255 characters. @@ -170,8 +177,7 @@ The type must be a valid string; for example, InfoPathUDC1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +187,9 @@ Accept wildcard characters: False ``` ### -WebAccessible + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the universal data connection file can be accessed by using the Web service. If false, only the forms server can retrieve the universal data connection files internally. The default value is False. @@ -188,8 +197,7 @@ The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +207,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -206,7 +217,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDefaultProfileConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDefaultProfileConfig.md index a70dc5626..07beb9d78 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDefaultProfileConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDefaultProfileConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes the MySitesPublicEnabled property of the User Profile Application Proxy. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the Set-SPDefaultProfileConfig cmdlet to change the MySitesPublicEnabled pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715)](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPDefaultProfileConfig $proxy -MySitesPublicEnabled $true @@ -40,10 +38,12 @@ Set-SPDefaultProfileConfig $proxy -MySitesPublicEnabled $true This example changes the MySitesPublicEnabled property of the specified user profile service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -MySitesPublicEnabled + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Enables or disables public MySites. The valid values are $True or $False. @@ -85,8 +89,7 @@ The valid values are $True or $False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,7 +127,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDesignerSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDesignerSettings.md index e6e830899..cb73c54f0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDesignerSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDesignerSettings.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets SharePoint Designer features. - ## SYNTAX ``` @@ -32,27 +31,27 @@ The `Set-SPDesignerSettings` cmdlet sets SharePoint Designer features on a speci For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ``` Set-SPDesignerSettings -WebApplication https://contoso -AllowRevertFromTemplate $False -AllowMasterPageEditing $False ``` This example disables the ability to detach pages from existing site definitions and to edit master pages and page layouts. - ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application in which the settings will apply. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,14 +61,16 @@ Accept wildcard characters: False ``` ### -AllowDesigner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to allow users to edit sites in a web application by using SharePoint Designer. The default value is True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +80,16 @@ Accept wildcard characters: False ``` ### -AllowMasterPageEditing + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to allow site administrators to customize master pages and layout pages using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +99,16 @@ Accept wildcard characters: False ``` ### -AllowRevertFromTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to allow site administrators to detach pages from the original site definition using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +132,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -152,14 +161,16 @@ Accept wildcard characters: False ``` ### -ShowURLStructure + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to allow site administrators to manage the URL structure of their Web sites by using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -AllowCreateDeclarativeWorkflow + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows the creation of declarative workflows. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,13 +217,15 @@ Accept wildcard characters: False ``` ### -AllowSaveDeclarativeWorkflowAsTemplate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows saving declarative workflows as a template. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -218,13 +235,15 @@ Accept wildcard characters: False ``` ### -AllowSavePublishDeclarativeWorkflow + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Allows saving of published declarative workflows. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -DesignerDownloadUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the URL to the SharePoint Designer download. The default value is: https://go.microsoft.com/fwlink/?LinkId=328584 @@ -241,8 +263,7 @@ https://go.microsoft.com/fwlink/?LinkId=328584 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,15 +273,17 @@ Accept wildcard characters: False ``` ### -RequiredDesignerVersion -Sets the required version of SharePoint Designer. The default value is + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Sets the required version of SharePoint Designer. The default value is 15.0.0.0 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticConfig.md index d5f4fcb46..ae137a999 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets diagnostic configuration settings on the farm. - ## SYNTAX ``` @@ -35,18 +34,16 @@ Use the `Set-SPDiagnosticConfig` cmdlet to set diagnostic configuration settings For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Set-SPDiagnosticConfig -ErrorReportingEnabled -DownloadErrorReportingUpdatesEnabled:$false -DaysToKeepLog 60 ``` This example enables ErrorReporting, disables DownloadErrorReportingUpdatesEnable and sets DaysToKeepLog to 60. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` $config = Get-SPDiagnosticConfig $config.CustomerExperienceImprovementProgramEnabled = $false @@ -56,17 +53,18 @@ $config | Set-SPDiagnosticConfig This example disables CEIP and sets LogCutInterval to 60 minutes. - ## PARAMETERS ### -AllowLegacyTraceProviders + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that trace providers built for previous versions of SharePoint Products and Technologies can write to the trace session for SharePoint Products. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +74,15 @@ Accept wildcard characters: False ``` ### -AppAnalyticsAutomaticUploadEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether aggregated app usage data is automatically uploaded to Microsoft. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +116,9 @@ Accept wildcard characters: False ``` ### -CustomerExperienceImprovementProgramEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether participation in the Customer Experience Improvement Program (CEIP) is enabled. The CEIP is designed to improve the quality, reliability, and performance of Microsoft products and technologies. @@ -129,8 +134,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,15 +144,17 @@ Accept wildcard characters: False ``` ### -DaysToKeepLogs -Specifies the number of days to keep trace log files. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the number of days to keep trace log files. The type must be a valid number between 1 and 366. The default value is 14 days. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +164,9 @@ Accept wildcard characters: False ``` ### -DownloadErrorReportingUpdatesEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the error reporting remote control file is downloaded. The type must be either of the following values: @@ -170,8 +179,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +189,9 @@ Accept wildcard characters: False ``` ### -ErrorReportingAutomaticUploadEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether error reports are uploaded to Microsoft automatically. Error reports include the following: information regarding the condition of the server when a problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. @@ -196,8 +207,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,6 +217,9 @@ Accept wildcard characters: False ``` ### -ErrorReportingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether collection of error reports is enabled. Error reports are created when your system encounters hardware or software problems. @@ -224,8 +237,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -235,6 +247,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the Event log flood protection feature is enabled. If multiple similar events are written to the event log, some duplicate messages are suppressed. @@ -250,8 +265,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -261,6 +275,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionNotifyInterval + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies in minutes how often to write a summary event indicating how many events were suppressed due to flood protection. The integer range is between 1 and 1440. @@ -269,8 +286,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -280,6 +296,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionQuietPeriod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies in minutes how much time must pass without an event firing to exit flood protection. The integer range is between 1 and 1440. @@ -288,8 +307,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -299,6 +317,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of events allowed in a given timeframe before an event is considered to be flooding the event log. The integer range is between 1 and 100. @@ -307,8 +328,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -318,6 +338,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionTriggerPeriod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies in minutes the timeframe to watch for events that may be flooding. The integer range is between 1 and 1440. @@ -326,8 +349,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -337,13 +359,15 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Use the result from the `Get-SPDiagnosticConfig` cmdlet, make modifications and then pipeline the object into `Set-SPDiagnosticConfig` cmdlet to update the content database. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -353,6 +377,9 @@ Accept wildcard characters: False ``` ### -LogCutInterval + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of minutes between log file rollovers. The value must be a valid integer between 0 and 1440. @@ -362,8 +389,7 @@ The default value is 30. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -373,6 +399,9 @@ Accept wildcard characters: False ``` ### -LogDiskSpaceUsageGB + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum amount of storage to use for trace log files, in gigabytes (GB). The default value is 1000 and only takes effect when the LogMaxDiskSpaceusageEnabled cmdlet is set to True. @@ -382,8 +411,7 @@ The type must be a valid number between 1 and 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -393,6 +421,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path of where to log files will reside. The type must be a valid path, in the form C:\Logs. @@ -402,8 +433,7 @@ The default location is %CommonProgramFiles%\Microsoft Shared\Web Server Extensi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -413,6 +443,9 @@ Accept wildcard characters: False ``` ### -LogMaxDiskSpaceUsageEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to restrict the maximum space to use for trace log files. The type must be either of the following values: @@ -425,8 +458,7 @@ The default value is $False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -436,6 +468,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingDelay + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time (in minutes) between script error reports. The type must be a valid integer between 0 and 1440. @@ -446,8 +481,7 @@ The default value is 30. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -457,6 +491,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether error reporting is enabled for client script errors. The type must be either of the following values: @@ -469,8 +506,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -480,6 +516,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingRequireAuth + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether script error reporting requires authentication. The type must be either of the following values: @@ -492,8 +531,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticsProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticsProvider.md index f09914367..ff7b58a5e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticsProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDiagnosticsProvider.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Enables a diagnostics provider and updates its retention policy. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Set-SPDiagnosticsProvider` cmdlet enables a diagnostics provider and update For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable:$false Get-SPDiagnosticsProvider job-diagnostics-event-log-provider @@ -40,8 +38,7 @@ Get-SPDiagnosticsProvider job-diagnostics-event-log-provider This example disables the event log diagnostics provider. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable -DaysRetained 10 Get-SPDiagnosticsProvider job-diagnostics-event-log-provider @@ -49,10 +46,12 @@ Get-SPDiagnosticsProvider job-diagnostics-event-log-provider This example enables the event log diagnostics provider and changes its retention policy to 10 days. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the diagnostics provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticProv1); or an instance of a valid SPDiagnosticsProvider object. @@ -60,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPDiagnosticsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -71,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -100,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,6 +112,9 @@ Accept wildcard characters: False ``` ### -DaysRetained + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days to retain the data collected by a diagnostics provider. The type must be a valid integer value in the range of 1 to 14. @@ -117,8 +122,7 @@ The type must be a valid integer value in the range of 1 to 14. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +132,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on or off the specified diagnostics provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +150,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -161,13 +169,15 @@ Accept wildcard characters: False ``` ### -MaxTotalSizeInBytes + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum size of the partition within the Usage database. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDistributedCacheClientSetting.md index 7f3b1e7f6..45a79f450 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDistributedCacheClientSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPDistributedCacheClientSetting.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets distributed cache settings. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Usage can be any type of cache that the ContainerType parameter specifies. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $settings = Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache $settings.MaxConnectionsToServer = 10 @@ -42,10 +40,12 @@ Set-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -D This example updates the MaxConnectionsToServer to 10 for DistributedLogonTokenCache. - ## PARAMETERS ### -ContainerType + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the container type to clear. The valid values are the following: @@ -70,12 +70,10 @@ The valid values are the following: -DistributedViewStateCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -85,14 +83,16 @@ Accept wildcard characters: False ``` ### -DistributedCacheClientSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Updates the various cache client settings. It is recommended to use the default settings. ```yaml Type: SPDistributedCacheClientSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -102,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEduServiceSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEduServiceSetting.md index 7aa4a5597..c6787ad8b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEduServiceSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEduServiceSetting.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Do not use - ## SYNTAX ``` @@ -24,29 +23,29 @@ Set-SPEduServiceSetting [[-Enabled] ] [-AssignmentCollection Applicable: SharePoint Server 2013 + +Do not use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013 Required: False Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -Enabled -Do not use + +> Applicable: SharePoint Server 2013 + +Do not use ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: 0 @@ -88,14 +91,16 @@ Accept wildcard characters: False ``` ### -Service -Do not use + +> Applicable: SharePoint Server 2013 + +Do not use ```yaml Type: Services Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Lync, Exchange, StudyGroup -Applicable: SharePoint Server 2013 Required: True Position: Named @@ -105,13 +110,15 @@ Accept wildcard characters: False ``` ### -Site -Do not use + +> Applicable: SharePoint Server 2013 + +Do not use ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -128,7 +138,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchAdministrationComponent.md index 5f46ad08e..45176f334 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchAdministrationComponent.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchAdministrationComponent.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of an administration component for a search service application. - ## SYNTAX ``` @@ -31,22 +30,23 @@ The Set-SPEnterpriseSearchAdministrationComponent cmdlet updates properties of a For permissions and the most current information about search cmdlets, see the online documentation, [https://go.microsoft.com/fwlink/?LinkId=163185](https://go.microsoft.com/fwlink/?LinkId=163185). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` - $ssa = Get-SPEnterpriseSearchServiceApplication "Search Service Application" + $ssa = Get-SPEnterpriseSearchServiceApplication "Search Service Application" $admin = Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa $admin | Set-SPEnterpriseSearchAdministrationComponent -SearchServiceInstance SP02 -Force ``` This example moves the administration component to a different server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -54,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the admin component must be moved to the new search service instance. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the administration component to update. The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid AdminComponent object. @@ -104,8 +110,7 @@ The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcde ```yaml Type: AdminComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the administration component. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -122,8 +130,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -SearchServiceInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance to host the administration component. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -140,8 +150,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -StoragePath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path for storing data for the administration component. The path must contain a valid file share and use valid registry characters. The type must be a valid path in either of the following forms: @@ -162,8 +174,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -180,7 +194,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md index 4b505ac33..ef4225287 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Stores the specified content enrichment configuration to the search service application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Both a ContentEnrichmentConfiguration and a SearchServiceApplication object have For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1 ------------------ +### EXAMPLE 1 ``` $config = New-SPEnterpriseSearchContentEnrichmentConfiguration $config.Endpoint = "https://server/service" @@ -46,12 +44,11 @@ Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -Co This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed properties. +The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. +It is also configured to expect the external web service to output the same managed properties. The SearchServiceApplication object is retrieved and used for storing the newly created ContentEnrichmentConfiguration. - -### ------------------EXAMPLE 2 ------------------ +### EXAMPLE 2 ``` C:\PS>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration $config.Endpoint = "https://server/service" @@ -64,22 +61,23 @@ Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -Co This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed property. +The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. +It is also configured to expect the external web service to output the same managed property. The $config.Trigger is set to only send the managed property when the Boolean trigger expression is true, in this case when the managed property Title contains the string "Example". The SearchServiceApplication object is retrieved, and used for storing the newly created ContentEnrichmentConfiguration. - ## PARAMETERS ### -ContentEnrichmentConfiguration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ContentEnrichmentConfiguration that should be stored in the SearchServiceApplication. ```yaml Type: ContentEnrichmentConfigurationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,13 +87,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -116,8 +119,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -144,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlContentSource.md index 1f5a8b582..a8e6b5ab1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlContentSource.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a crawl content source for a Search service application. - ## SYNTAX ### MonthlyDate @@ -87,10 +86,9 @@ Search service application administrators can still configure full crawls as nee For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $cs = Get-SPEnterpriseSearchCrawlContentSource -Identity 'Local SharePoint Sites' -SearchApplication $ssa @@ -100,10 +98,12 @@ $cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Incremental -DailyC This example returns the "Local SharePoint Sites" content source and creates a schedule to run a full crawl every 30 days and an incremental crawl every hour every day. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,12 +112,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,15 +125,16 @@ Accept wildcard characters: False ``` ### -BDCApplicationProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy to use for a business type content source. This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,15 +144,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -163,17 +163,18 @@ Accept wildcard characters: False ``` ### -CrawlPriority + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the priority of this content source. The type must be one of the following integers: 1= Normal, 2=High. - ```yaml Type: CrawlPriority Parameter Sets: (All) Aliases: p Accepted values: Normal, High -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -183,14 +184,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleDaysOfMonth -Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set. ```yaml Type: Int32 Parameter Sets: MonthlyDate -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,15 +202,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleDaysOfWeek -Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set. ```yaml Type: DaysOfWeek Parameter Sets: Weekly -Aliases: +Aliases: Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Weekdays, Saturday, Weekends, Everyday -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -218,15 +221,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleMonthsOfYear -Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set. ```yaml Type: MonthsOfYear Parameter Sets: MonthlyDate Aliases: month Accepted values: January, February, March, April, May, June, July, August, September, October, November, December, AllMonths -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -236,14 +240,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRepeatDuration -Specifies the number of times to repeat the crawl schedule. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the number of times to repeat the crawl schedule. ```yaml Type: Int32 Parameter Sets: MonthlyDate, Weekly, Daily Aliases: duration -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -253,14 +258,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRepeatInterval -Specifies the number of minutes between each repeat interval for the crawl schedule +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the number of minutes between each repeat interval for the crawl schedule ```yaml Type: Int32 Parameter Sets: MonthlyDate, Weekly, Daily Aliases: interval -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -270,18 +276,19 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRunEveryInterval + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the interval between crawls. When the DailyCrawlSchedule parameter is set, specifies the number of days between crawls. When the WeeklyCrawlSchedule parameter is set, specifies the number of weeks between crawls. - ```yaml Type: Int32 Parameter Sets: Weekly, Daily Aliases: every -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -291,15 +298,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleStartDateTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the initial date of the crawl. The default value is midnight on the current day. - ```yaml Type: DateTime Parameter Sets: MonthlyDate, Weekly, Daily Aliases: start -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -309,14 +317,15 @@ Accept wildcard characters: False ``` ### -CustomProtocol -Specifies the custom protocol, handled by the custom connector, to use for this content source. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the custom protocol, handled by the custom connector, to use for this content source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -326,14 +335,15 @@ Accept wildcard characters: False ``` ### -DailyCrawlSchedule -Base schedule on days between crawls. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Base schedule on days between crawls. ```yaml Type: SwitchParameter Parameter Sets: Daily Aliases: daily -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -343,14 +353,15 @@ Accept wildcard characters: False ``` ### -EnableContinuousCrawls -Specifies the value of the EnableContinuousCrawls parameter: True or False. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the value of the EnableContinuousCrawls parameter: True or False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -360,16 +371,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl content source to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. - ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -379,14 +391,15 @@ Accept wildcard characters: False ``` ### -LOBSystemSet -Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -396,14 +409,15 @@ Accept wildcard characters: False ``` ### -MaxPageEnumerationDepth -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -413,14 +427,15 @@ Accept wildcard characters: False ``` ### -MaxSiteEnumerationDepth -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -430,14 +445,15 @@ Accept wildcard characters: False ``` ### -MonthlyCrawlSchedule -Base the schedule on months between crawls. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Base the schedule on months between crawls. ```yaml Type: SwitchParameter Parameter Sets: MonthlyDate Aliases: monthly -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -447,16 +463,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new display name for the content source. The type must be a valid name of a content source; for example, ContentSource1. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -466,14 +483,15 @@ Accept wildcard characters: False ``` ### -RemoveCrawlSchedule -Deletes the specified crawl. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Deletes the specified crawl. ```yaml Type: SwitchParameter Parameter Sets: RemoveSchedule -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -483,17 +501,18 @@ Accept wildcard characters: False ``` ### -ScheduleType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of crawl schedule. The type must be one of the following values: Full or Incremental. - ```yaml Type: ContentSourceCrawlScheduleType -Parameter Sets: MonthlyDate, Weekly, RemoveSchedule -Aliases: +Parameter Sets: Daily, MonthlyDate, Weekly, RemoveSchedule +Aliases: Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -502,31 +521,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ContentSourceCrawlScheduleType -Parameter Sets: Daily -Aliases: -Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -SearchApplication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -SearchApplication Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -536,16 +542,17 @@ Accept wildcard characters: False ``` ### -StartAddresses + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the comma-separated list of URLs at which to start a crawl for this content source. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -555,17 +562,18 @@ Accept wildcard characters: False ``` ### -Tag + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL for the page to modify the settings for a custom content source. The string that specifies the URL can contain a maximum of 1,024 characters. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -575,14 +583,15 @@ Accept wildcard characters: False ``` ### -WeeklyCrawlSchedule -Base the schedule on weeks between crawls. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Base the schedule on weeks between crawls. ```yaml Type: SwitchParameter Parameter Sets: Weekly Aliases: weekly -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -592,15 +601,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlDatabase.md index 30e1ea54f..f7c70ab3c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a crawl database for a Search service application. - ## SYNTAX ``` @@ -32,10 +31,9 @@ A crawl database stores crawl history for a Search service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer @@ -43,10 +41,12 @@ Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore -SearchApplic This example sets the failover database server for the crawl database, SearchApp_CrawlStore, to the \\\\failoverServer server. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl database to modify. A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. @@ -54,8 +54,7 @@ A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 1 ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,15 +88,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -105,13 +107,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server to be used for failover when SQL Server mirroring is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +125,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application to which the crawl database applies. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -128,8 +135,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,13 +164,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +182,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the Microsoft SQL Server database server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +200,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +218,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account name on the Database Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlLogReadPermission.md index 408f46985..8f4f21624 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlLogReadPermission.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Grants users permission to view the crawl log information. - ## SYNTAX ``` @@ -32,10 +31,9 @@ The administrator can choose to restrict the permission to crawl log information For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" @@ -45,10 +43,12 @@ Set-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -Sear This example first defines $crawlLogPermission, which is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. Then the example uses the `Set-SPEnterpriseSearchCrawlLogReadPermission` cmdlet to add user1 and user2 to the list of users referenced by $crawlLogPermission. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -60,8 +60,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -78,7 +80,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -88,13 +89,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawl log permissions list to which users should be added. ```yaml Type: CrawlLogReadPermissionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +107,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the crawl log. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +126,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the users shall be added to the crawl log permissions list within the scope of this tenant only. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,14 +145,16 @@ Accept wildcard characters: False ``` ### -UserNames + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user names that shall be granted permission to view the crawl log information Use "domain\username" or "username". When adding several user names, separate names with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlRule.md index b0588cc83..76212646c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchCrawlRule.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties for a crawl rule. - ## SYNTAX ``` @@ -32,10 +31,9 @@ A search administrator runs the `Set-SPEnterpriseSearchCrawlRule` cmdlet at init For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $crawlRule = Get-SPEnterpriseSearchCrawlRule -Identity 'file://fileserver/root' -SearchApplication $ssa @@ -44,17 +42,18 @@ Set-SPEnterpriseSearchCrawlRule -Identity $crawlRule -Type "ExclusionRule" This example sets the type of the crawl rule pertaining to the URL, file://fileserver/root, to exclude this path from future crawls. - ## PARAMETERS ### -AccountName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the account to be used to crawl content identified by the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,13 +63,15 @@ Accept wildcard characters: False ``` ### -AccountPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for AccountName. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,12 +92,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +105,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the following authentication types: - BasicAccountRuleAccess -Specifies basic authentication. @@ -111,12 +116,10 @@ Specifies one of the following authentication types: - NTLMAccountRuleAccess -Specifies the account name for integrated authentication. - ```yaml Type: CrawlRuleAuthenticationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,15 +129,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -144,14 +148,15 @@ Accept wildcard characters: False ``` ### -ContentClass -Specifies a string that is sent to the protocol handler for any content that matches the crawl rule. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies a string that is sent to the protocol handler for any content that matches the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +166,15 @@ Accept wildcard characters: False ``` ### -CrawlAsHttp -Specifies whether the crawler crawls content from a hierarchical content source as HTTP content. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the crawler crawls content from a hierarchical content source as HTTP content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,14 +184,15 @@ Accept wildcard characters: False ``` ### -FollowComplexUrls -Specifies whether the index engine crawls content from URLs that contain a question mark (?). +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the index engine crawls content from URLs that contain a question mark (?). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -195,16 +202,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the crawl rule. The type must be a valid crawl rule URL, such as https://server_name, or an instance of a valid CrawlRule object. - ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -214,16 +222,17 @@ Accept wildcard characters: False ``` ### -IsAdvancedRegularExpression + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the rule has full regular expression syntax. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -233,14 +242,15 @@ Accept wildcard characters: False ``` ### -PluggableSecurityTimmerId -Specifies the ID of the custom pluggable security trimmer to use, if registered. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the ID of the custom pluggable security trimmer to use, if registered. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -250,16 +260,17 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines where in the list of crawl rules this crawl rule is to be applied. The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -269,16 +280,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the search application that is associated with the crawl rule to be modified. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -288,14 +300,15 @@ Accept wildcard characters: False ``` ### -SuppressIndexing -Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -305,15 +318,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of crawl rule. A value of zero (0) includes the rule and a value of 1 excludes the rule. - ```yaml Type: CrawlRuleType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -323,15 +337,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchFileFormatState.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchFileFormatState.md index 6212622bc..fea45e117 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchFileFormatState.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchFileFormatState.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the activation state of a parser for a given file format. - ## SYNTAX ``` @@ -32,10 +31,9 @@ The system will only consider the change after a restart of the content processi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa -Identity PDF -Enable $false @@ -43,18 +41,18 @@ Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa -Identity PDF -Ena This example uses the `Set-SPEnterpriseSearchFileFormatState` cmdlet to disable the parser for the file format "PDF". - ## PARAMETERS ### -Identity -Specifies the identification of the format to be disabled or enabled. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the identification of the format to be disabled or enabled. ```yaml Type: DocumentParserFileFormatStatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,15 +62,16 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the activation state of the parser that corresponds to the specified file format. The activation state can be $FALSE (disabled) or $TRUE (enabled). - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -82,15 +81,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -100,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -139,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,13 +162,15 @@ Accept wildcard characters: False ``` ### -UseIFilter + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies use of a third-party iFilter when parsing the file format. UseIFilter can be $false (built-in format handler is used) or $TRUE (third-party iFilter is used). $false is the default value. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinguisticComponentsStatus.md index 7c78e4d64..58670f1ea 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinguisticComponentsStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinguisticComponentsStatus.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the operation status of the linguistic query and document processing components. - ## SYNTAX ``` @@ -31,10 +30,9 @@ This cmdlet sets the operational status of the linguistic query and document pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -StemmingEnabled $false @@ -42,8 +40,7 @@ Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -Stemmi This example shows how to disable stemming during query processing by setting the parameter StemmingEnabled to false. - -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -AllEnabled $false @@ -51,18 +48,18 @@ Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -AllEna This example shows how to disable all linguistic query and document processing functionalities. - ## PARAMETERS ### -AllEnabled -A Boolean value to enable or deactivate all linguistic functionalities. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate all linguistic functionalities. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,12 +80,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,14 +93,15 @@ Accept wildcard characters: False ``` ### -EntityExtractionEnabled -A Boolean value to enable or deactivate the company extractor and all custom extractors during document processing. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate the company extractor and all custom extractors during document processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,14 +111,15 @@ Accept wildcard characters: False ``` ### -Identity -An object that represents the current status of the linguistic components. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +An object that represents the current status of the linguistic components. ```yaml Type: LinguisticComponentsStatusPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +129,15 @@ Accept wildcard characters: False ``` ### -QuerySpellingEnabled -A Boolean value to enable or deactivate query spelling correction. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate query spelling correction. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +147,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the linguistic processing components. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service application that contains the linguistic processing components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -163,14 +165,15 @@ Accept wildcard characters: False ``` ### -StemmingEnabled -A Boolean value to enable or deactivate expansive stemming during query processing. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate expansive stemming during query processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +183,15 @@ Accept wildcard characters: False ``` ### -ThesaurusEnabled -A Boolean value to enable or deactivate thesaurus lookup during query processing. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate thesaurus lookup during query processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinksDatabase.md index f33e7a5e8..aa0e9feb6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchLinksDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a links database for a search service application. - ## SYNTAX ``` @@ -32,10 +31,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp Set-SPEnterpriseSearchLinksDatabase -Identity SearchApp_LinksStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer @@ -43,18 +41,19 @@ Set-SPEnterpriseSearchLinksDatabase -Identity SearchApp_LinksStore -SearchApplic This example sets the failover database server to \\\\failoverServer for the links database SearchApp_LinksStore in the search service application mySearchServiceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the links database to modify. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,13 +106,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the links database name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the account to connect to the database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server to use for the host SQL database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the account to connect to the database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the server to use for failover when using SQL Server mirroring. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +196,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -207,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCategory.md index 2b44b0b85..c23518ef3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCategory.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a crawled property category. - ## SYNTAX ``` @@ -34,10 +33,9 @@ Changes to the category will overwrite all propsets. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $ssa -DiscoverNewProperties $false -MapToContents $false @@ -45,10 +43,12 @@ Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $ssa This example sets both DiscoverNewProperties and MapToContents properties to False for the People category for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,12 +57,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -72,17 +70,18 @@ Accept wildcard characters: False ``` ### -AutoCreateNewManagedProperties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: auto -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -92,15 +91,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,17 +110,18 @@ Accept wildcard characters: False ``` ### -DiscoverNewProperties + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,16 +131,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata category to update. The type must be a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -149,17 +151,18 @@ Accept wildcard characters: False ``` ### -MapToContents + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: m -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -169,6 +172,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the enterprise search metadata category. The type must be a valid name of a metadata category, for example MetadataCategory1. @@ -176,12 +182,10 @@ The type must be a valid name of a metadata category, for example MetadataCatego Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -191,16 +195,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the enterprise search metadata categories. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -210,15 +215,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCrawledProperty.md index 2c12b0b8d..c3cf18421 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataCrawledProperty.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a metadata crawled property. - ## SYNTAX ``` @@ -29,10 +28,9 @@ SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $crawlprop = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name MyCrawlProp @@ -41,10 +39,12 @@ Set-SPEnterpriseSearchMetadataCrawledProperty -Identity $crawlprop -IsMappedToCo This example sets the IsMappedToContent parameter of the crawled property MyCrawlProp to false (see the example for the `New-SPEnterpriseSearchMetadataCrawledProperty` command) for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +53,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -68,15 +66,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -86,16 +85,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawled property to update. The type must be an instance of a valid CrawledProperty object. - ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -105,15 +105,16 @@ Accept wildcard characters: False ``` ### -IsMappedToContents + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the crawled property is mapped to managed properties. Specify true to map a crawled property to a managed property. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -123,15 +124,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataManagedProperty.md index acea23293..d09368f01 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataManagedProperty.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a metadata managed property. - ## SYNTAX ``` @@ -35,10 +34,9 @@ SPEnterpriseSearchMetadataManagedProperty represents a managed property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -EnabledForScoping $true @@ -46,10 +44,12 @@ Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity This example sets the EnabledForScoping property to true for the managed property named UserName in the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -58,12 +58,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,15 +71,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -91,17 +90,18 @@ Accept wildcard characters: False ``` ### -DefaultForQueryIndependentRank + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). Note: Null indicates that the value is unchanged. - ```yaml Type: UInt32 Parameter Sets: (All) Aliases: def -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -111,18 +111,19 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a description to the metadata managed property. The type must be a valid string. Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -132,6 +133,9 @@ Accept wildcard characters: False ``` ### -EnabledForQueryIndependentRank + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. The type must be one of the following query-independent ranking features in the custom model XML: @@ -142,12 +146,10 @@ The type must be one of the following query-independent ranking features in the Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: qir -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -157,16 +159,17 @@ Accept wildcard characters: False ``` ### -EnabledForScoping + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property can be used in a scope definition. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -176,16 +179,17 @@ Accept wildcard characters: False ``` ### -FullTextQueriable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property can be used in enterprise search SQL queries. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -195,16 +199,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to update. The type must be a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object - ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -214,13 +219,15 @@ Accept wildcard characters: False ``` ### -IncludeInAlertSignature + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether this managed property should be included in alert signature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: ia -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -230,16 +237,17 @@ Accept wildcard characters: False ``` ### -IncludeInMd5 + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im5 -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -249,18 +257,19 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a name for the managed property. The type must be a valid managed property name, for example ManagedProperty1. Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -270,17 +279,18 @@ Accept wildcard characters: False ``` ### -NameNormalized + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. If value is set to true, the values are normalized. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nn -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -290,16 +300,17 @@ Accept wildcard characters: False ``` ### -NoWordBreaker + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the values for this managed property are processed by a word breaker. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nw -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -309,14 +320,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that duplicate values for the managed property are removed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rd -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -326,17 +338,18 @@ Accept wildcard characters: False ``` ### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. Otherwise, all mapped crawled properties that have a value are copied. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: rp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -346,16 +359,17 @@ Accept wildcard characters: False ``` ### -Retrievable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the values for this managed property are retrievable or not. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -365,13 +379,15 @@ Accept wildcard characters: False ``` ### -SafeForAnonymous + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether it is acceptable to display the contents of the property in search results for anonymous searches. ```yaml Type: Boolean Parameter Sets: (All) Aliases: sfa -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -381,16 +397,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -400,16 +417,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -419,16 +437,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -438,16 +457,17 @@ Accept wildcard characters: False ``` ### -UserFlags + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Reserved for future use. Note: Null indicates that the value is unchanged. - ```yaml Type: Int16 Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -457,15 +477,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataMapping.md index a11da74f0..ab44fb7e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchMetadataMapping.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a managed property mapping for a search service application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ SPEnterpriseSearchMetadataMapping represents a mapping between a managed propert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication ## get the crawl property to set to, in this case a new property is created @@ -51,10 +49,12 @@ Set-SPEnterpriseSearchMetadataMapping -Identity $map -SearchApplication $ssa -Cr This example updates an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `New-SPEnterpriseSearchMetadataMapping`) for the default search service application. The crawled property is replaced with a new crawled property named MyNewCrawlProp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the metadata mapping to update. The type must be a valid URL, in the form https://server_name, or an instance of a valid Mapping object. @@ -62,8 +62,7 @@ The type must be a valid URL, in the form https://server_name, or an instance of ```yaml Type: MappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the metadata mapping. The type be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -80,8 +82,7 @@ The type be a valid search application name, for example, SearchApp1, or an inst ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -CrawledProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the crawled property to map. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -139,8 +147,7 @@ Note: Null indicates that the value is unchanged. ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed property to receive the crawled property mapping. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -159,8 +169,7 @@ Note: Null indicates that the value is unchanged. ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -177,8 +189,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +199,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the metadata mappings returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -195,8 +209,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +219,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -213,7 +229,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchPrimaryHostController.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchPrimaryHostController.md index 98a8f7667..9c6671743 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchPrimaryHostController.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchPrimaryHostController.md @@ -27,12 +27,11 @@ This cmdlet sets the primary SearchHostController for the farm to the defined Se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` -$si = Get-SPEnterpriseSearchServiceInstance -Local +$si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchPrimaryHostController $si ``` @@ -41,10 +40,9 @@ It is up to the user to select the HostController with latest version available. If you choose a SearchHostController that is not running the latest version of the repository, you will have to confirm before you continue. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` -$si = Get-SPEnterpriseSearchServiceInstance -Local +$si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchPrimaryHostController $si -Force ``` @@ -52,17 +50,18 @@ This example sets the local SearchHostController instance as the new primary Sea If you choose a SearchHostController that is not running the latest version of the repository, you will not get a confirmation message before you continue. - ## PARAMETERS ### -SearchServiceInstance + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + SearchServiceInstance of the server from where the SearchHostController object is returned. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +85,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +105,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -111,14 +114,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Force the change of the primary SearcHostController. No confirmation messages are asked, even if user tries to set primary to a SearchHostController not running the latest version of the repository. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryAuthority.md index 687881f7c..d4b9acf82 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryAuthority.md @@ -29,20 +29,21 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPEnterpriseSearchQueryAuthority -Identity https://contoso.com -Level 0.5 -SearchApplication MySSA ``` This example adjusts the authoritative level of the URL https://contoso.com to 0.5 on the search service application named MySSA. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,12 +52,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,15 +65,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -84,16 +84,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query authority page to update. The type must be a valid URL, in the form https://server_name; or an instance of a valid AuthorityPage object. - ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +104,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the level of the new authoritative page. Authoritative pages, designated by the service application administrator, are expert pages that link to the most relevant information. Because a search service application can have several designated authoritative pages, you use the Level property to specify the value of a specific page. @@ -110,12 +114,10 @@ This parameter sets the level for the most valuable authoritative pages to 0. The type must be one of the following floating-point numbers: 0, 1, or 2. - ```yaml Type: Single Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -125,14 +127,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -142,16 +145,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the authority page collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -161,15 +165,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryKeyword.md index 857efb9e2..2c667371e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryKeyword.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a keyword term for a shared search application. - ## SYNTAX ``` @@ -34,20 +33,21 @@ You can use this cmdlet for keywords in site collections that are in SharePoint For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site https://myserver/sites/engineering ``` This example gets a reference to the keyword with the term Engineering from the site https://myserver/sites/engineering and sets the start dates and end dates for the keyword. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,12 +56,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -71,15 +69,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -89,16 +88,17 @@ Accept wildcard characters: False ``` ### -Contact + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name associated with the new keyword. The type must be a valid user name; for example, KeywordUser1. - ```yaml Type: String Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,16 +108,17 @@ Accept wildcard characters: False ``` ### -Definition + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the definition of the new keyword term. The type must be a valid string; for example, a keyword term definition. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,17 +128,18 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -147,16 +149,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the keyword term to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. - ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -166,17 +169,18 @@ Accept wildcard characters: False ``` ### -ReviewDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the review date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -186,16 +190,17 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Associates the new keyword term to the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. - ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -205,17 +210,18 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the activation date for the keyword term. The default value is the current date. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -225,16 +231,17 @@ Accept wildcard characters: False ``` ### -Term + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the keyword term that triggers keyword results. The type must be a valid string; for example, a keyword term. - ```yaml Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -244,15 +251,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScope.md index 57b880171..48a690d97 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScope.md @@ -37,10 +37,9 @@ SPEnterpriseSearchQueryScope represents a query results scope used by all shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPenterpriseSearchServiceApplication Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage https://altServer @@ -48,20 +47,20 @@ Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | S This example obtains a reference to the scope named MustCrawl on the search service application named MySSA and changes the description, compilation type and alternate access URL. - ## PARAMETERS ### -AlternateResultsPage + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the location to display results for the new query scope. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,12 +81,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,17 +94,18 @@ Accept wildcard characters: False ``` ### -CompilationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the compilation type of the new scope. The value 0 specifies the conditionally compiled scope type, and the value 1 specifies the always compiled scope type. The type must be either of the following: 0 or 1. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -114,15 +115,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -132,16 +134,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a description of the new query scope. The type must be a valid string; for example, a description of a query scope. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,15 +154,16 @@ Accept wildcard characters: False ``` ### -DisplayInAdminUI + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new scope is displayed in the administration application user interface (UI). The default setting is to hide the new scope in the administration application UI. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: disp -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -169,16 +173,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the scope to create. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -188,16 +193,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a name for the query scope. The type must be a valid name of a query scope; for example, QueryScope1. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -207,16 +213,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -226,16 +233,17 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Filters to delete scopes for the specified results URL. The type must be a valid URL, in the form https://server_name. - ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -245,15 +253,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScopeRule.md index dd3476ee2..4c3b78afc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQueryScopeRule.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a shared scope rule for a query scope. - ## SYNTAX ``` @@ -39,10 +38,9 @@ SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -51,10 +49,12 @@ Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url https://criticalSite | S This example gets a reference to a scope rule for the URL https://criticalSite and sets its rule type to Url. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope rule to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance a valid ScopeRule object. @@ -62,8 +62,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the results URL that is associated with the query scope rule. The type must be a valid URL, in the form https://server_name. @@ -81,7 +83,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -FilterBehavior + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of scope rule to create for the query scope. The type must be one of the following values: Exclude, Include, or Require. @@ -138,7 +146,6 @@ The type must be one of the following values: Exclude, Include, or Require. Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -ManagedPropertyName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the managed property to use for the PropertyQuery scope rule. The type must be a valid name of a managed property; for example, ManagedProp1. @@ -156,7 +166,6 @@ The type must be a valid name of a managed property; for example, ManagedProp1. Type: String Parameter Sets: (All) Aliases: mname -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,13 +175,15 @@ Accept wildcard characters: False ``` ### -MatchingString + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the string to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: text -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the property value to use when matching the PropertyQuery rule type. ```yaml Type: String Parameter Sets: (All) Aliases: value -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Applies the query scope rule to the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -206,7 +222,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -223,8 +241,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -234,6 +251,9 @@ Accept wildcard characters: False ``` ### -UrlScopeRuleType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value to use when matching the URL rule type. The type must be one of the following values: Folder, HostName, or Domain. @@ -242,7 +262,6 @@ The type must be one of the following values: Folder, HostName, or Domain. Type: String Parameter Sets: (All) Aliases: ut -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -252,6 +271,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -259,7 +281,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQuerySpellingCorrection.md index 56486cead..e2dd0c78a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQuerySpellingCorrection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchQuerySpellingCorrection.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSEarchQuerySpellingCorrection -SearchApplication $ssa -SpellingDictionary dynamic @@ -41,10 +41,12 @@ Set-SpEnterpriseSEarchQuerySpellingCorrection -SearchApplication $ssa -SpellingD This example sets the dictionary named dynamic to be used for query spelling correction for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +55,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -68,14 +68,15 @@ Accept wildcard characters: False ``` ### -ContentAlignmentEnabled -A Boolean value to enable or deactivate the content alignment process. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate the content alignment process. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,15 +86,16 @@ Accept wildcard characters: False ``` ### -DiacriticsInSuggestionsEnabled -A switch to enable or disable spelling suggestions that contain diacritics (for example, German umlaut umlaut). -The default setting is true. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A switch to enable or disable spelling suggestions that contain diacritics (for example, German umlaut umlaut). +The default setting is true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +105,15 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an object that represents the current status for the query spelling correction. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies an object that represents the current status for the query spelling correction. ```yaml Type: QuerySpellingCorrectionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,15 +123,16 @@ Accept wildcard characters: False ``` ### -MaxDictionarySize + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximal number of terms in a content-aligned spelling dictionary. In a multi-tenant environment, this number is valid per tenant. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,15 +142,16 @@ Accept wildcard characters: False ``` ### -MaxProcessingTime + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum runtime for compiling a content-aligned spelling dictionary. The default value is 6 hours. - ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +161,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the QSC components. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search service application that contains the QSC components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -173,15 +179,16 @@ Accept wildcard characters: False ``` ### -SecurityTrimmingEnabled -A Boolean value to enable or deactivate the security check for spelling suggestions. -If enabled, only spelling suggestions that deliver at least one document for the current user are shown. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +A Boolean value to enable or deactivate the security check for spelling suggestions. +If enabled, only spelling suggestions that deliver at least one document for the current user are shown. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,17 +198,18 @@ Accept wildcard characters: False ``` ### -SpellingDictionary + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the dictionary to be used for query spelling correction. The two available values are dynamic and static. When value is set to dynamic, the query spelling correction uses the content-aligned dictionary. When value is set to static, the query spelling correction uses the out of the box static spelling dictionaries. - ```yaml Type: SpellingDictionaryType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -211,15 +219,16 @@ Accept wildcard characters: False ``` ### -TermFrequencyThreshold + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the minimum number of documents that must contain the most frequently used term in the document collection for the content-alignment process to be executed. In a multi-tenant environment, this number is valid per tenant. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchRankingModel.md index 67b7ac51d..d1caf7d8f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchRankingModel.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a ranking model for a shared search service application. - ## SYNTAX ``` @@ -31,14 +30,13 @@ If the Identity parameter is not specified or the identity does not match any of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level ssa -$rankingModel = Get-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner +$rankingModel = Get-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner $newrankmodel = Get-Content .\newRankModel.xml $newrankmodel = [String]$newrankmodel Set-SPEnterpriseSearchRankingModel -Identity $rankingModel -SearchApplication $ssa -Owner $owner -RankingModelXML $newrankmodel @@ -46,10 +44,12 @@ Set-SPEnterpriseSearchRankingModel -Identity $rankingModel -SearchApplication $s This example reconfigures the ranking model with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 with the new ranking model specified in newRankModel.xml. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ranking model to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. @@ -57,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -68,6 +67,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -76,7 +78,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -86,13 +87,15 @@ Accept wildcard characters: False ``` ### -RankingModelXML + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the XML representation of the new ranking model. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +119,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application that contains the ranking model. The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -148,8 +158,7 @@ The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a val ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -166,7 +178,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultItemType.md index aebe7e63e..488b86040 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultItemType.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a result item type. - ## SYNTAX ``` @@ -45,10 +44,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $web = Get-SPWeb https://webUrl $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web @@ -61,12 +59,12 @@ $ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection $ruleCollection.Add($rule) $displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime" $displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js" -Set-SPEnterpriseSearchResultItemType +Set-SPEnterpriseSearchResultItemType -Identity $resultType ` -SearchApplication $ssa ` -Name "CustomResultType" ` -Rules $ruleCollection ` --RulePriority 1 +-RulePriority 1 -DisplayProperties $displayProperties ` -DisplayTemplateUrl $displaytemplateUrl ` -Owner $tenantOwner @@ -82,18 +80,19 @@ Next, the example defines which properties of the result item type that shall be Finally, the example uses the `Set-SPEnterpriseSearchResultItemType` cmdlet to modify the result item type. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -103,13 +102,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search object owner that defines the scope at which the result item type was created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -119,6 +120,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +134,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +144,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,13 +163,15 @@ Accept wildcard characters: False ``` ### -DisplayProperties + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which result properties to display. ```yaml Type: String Parameter Sets: (All) Aliases: dp -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -174,13 +181,15 @@ Accept wildcard characters: False ``` ### -DisplayTemplateUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the display template that shall be used for rendering the results. ```yaml Type: String Parameter Sets: (All) Aliases: url -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -190,13 +199,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the result item type. ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -206,13 +217,15 @@ Accept wildcard characters: False ``` ### -OptimizeForFrequentUse + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{ Fill OptimizeForFrequentUse Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: opt -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -222,13 +235,15 @@ Accept wildcard characters: False ``` ### -RulePriority + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies which priority the collection of rules has compared to other rules. ```yaml Type: Int32 Parameter Sets: (All) Aliases: priority -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -238,13 +253,15 @@ Accept wildcard characters: False ``` ### -Rules + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the collection of rules to evaluate the result properties against. ```yaml Type: PropertyRuleCollection Parameter Sets: (All) Aliases: rule -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -254,14 +271,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -271,14 +290,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -288,13 +309,15 @@ Accept wildcard characters: False ``` ### -SourceID + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Identifies the search result source that the result item type applies to. ```yaml Type: Guid Parameter Sets: (All) Aliases: sid -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -304,6 +327,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -311,7 +337,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultSource.md index 9ce87971c..689fc62e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchResultSource.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a result source. - ## SYNTAX ``` @@ -33,10 +32,9 @@ This cmdlet supports the same update operations as are supported through the "Ma The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true) for any update operation other than changing the default result source using the MakeDefault parameter. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -44,11 +42,10 @@ $customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa Set-SPEnterpriseSearchResultSource -Identity $customResultSource -Name "Basic SharePoint Result Source" ``` -This example updates the name of the result source and the identity of the result source is specified as a result source instance. +This example updates the name of the result source and the identity of the result source is specified as a result source instance. SearchApplication and Owner are not required for this update operation. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -58,24 +55,24 @@ Set-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Identi This example updates the description of the result source and the identity of the result source is specified by name. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - + When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +82,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an authentication type for the result source. If parameter is not specified, the value is unchanged. A specific set of authentication types are supported for each search provider type and if parameter is not specified, the authentication type will default based on search provider type. @@ -95,16 +95,14 @@ When using a Local SharePoint Search/Local SharePoint People Search provider, th When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. +When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. All authentication types are listed in the enum FederationAuthType. - ```yaml Type: FederationAuthType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +112,9 @@ Accept wildcard characters: False ``` ### -AutoDiscover + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to use automatic discovery of the Exchange server endpoint for the result source. Setting value to true ($true) states that automatic discovery should be used. @@ -122,12 +123,10 @@ If parameter is not specified, the value is unchanged. Only applicable when using an Exchange search provider. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,15 +136,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -155,16 +155,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a description for the result source. If parameter is not specified, the value is unchanged. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,16 +175,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the result source to update. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -193,22 +195,23 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the result source should be set as default result source or not, for the scope specified by the Owner parameter. If parameter is not specified, the default result source will not change. Setting value to true ($true) states that the result source should be set as default. -Setting value to false ($false) states that the result source should not be set as default and in this case, if the result source to update is currently the default, the original default result source ("Local SharePoint Results") will be set as default again. +Setting value to false ($false) states that the result source should not be set as default and in this case, if the result source to update is currently the default, the original default result source ("Local SharePoint Results") will be set as default again. Tip: Use instance, not name or GUID string Id, as Identity when using Makedefault, to clearly specify that Owner is only to be used for specifying the level where the result source should be set as default (if value is true) or where the default should be reset to original (if value is false). - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -218,6 +221,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a name for the result source. If parameter is not specified, the value is unchanged. @@ -226,12 +232,10 @@ Names must be unique at each administrative level. For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +245,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -258,18 +263,19 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password of the user credentials to use to connect to the result source. If parameter is not specified, the value is unchanged. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -279,18 +285,19 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a search provider to be used by the result source. If parameter is not specified, the value is unchanged. Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -300,6 +307,9 @@ Accept wildcard characters: False ``` ### -QueryTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the query transformation template of the result source. If parameter is not specified, the value is unchanged. @@ -312,12 +322,10 @@ For example, to only return OneNote items, set the new text to "{searchTerms} fi Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". Default value is {searchTerms}. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -327,13 +335,16 @@ Accept wildcard characters: False ``` ### -RemoteUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a connection URL template for the result source. If parameter is not specified, the value is unchanged. Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1, and Exchange (if AutoDiscover is not turned on). -When using other search providers the parameter is ignored. +When using other search providers the parameter is ignored. For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. @@ -342,12 +353,10 @@ For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. For Exchange, specify the Exchange EWS URL from which to retrieve results. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -357,16 +366,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -376,6 +386,9 @@ Accept wildcard characters: False ``` ### -SsoId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the reverse proxy certificate Secure Store Id to use to connect to the result source. If parameter is not specified, the value is unchanged. @@ -384,12 +397,10 @@ Must be specified if authentication type (AUthenticationType) is set to Federati If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -399,18 +410,19 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name of the user credentials to use to connect to the result source. If parameter is not specified, the value is unchanged. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -420,15 +432,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchService.md index 72b43cea8..d8502ca50 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchService.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a search service for a farm. - ## SYNTAX ``` @@ -31,10 +30,9 @@ This cmdlet updates properties of a search service for a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $password = Read-Host -AsSecureString Set-SPEnterpriseSearchService -IgnoreSSLWarnings $true -ServiceAccount 'contoso\adminAccount' -ServicePassword $password @@ -42,10 +40,12 @@ Set-SPEnterpriseSearchService -IgnoreSSLWarnings $true -ServiceAccount 'contoso\ This example configures the search service to ignore SSL warnings and changes the service account for the search service. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchService1); or an instance of a valid SearchService object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -64,16 +63,17 @@ Accept wildcard characters: False ``` ### -AcknowledgementTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time in seconds that the search server will wait for request acknowledgement while connecting to other services. The type must be string input that can be parsed to an integer value. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -122,16 +126,17 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time in seconds that the search server waits while connecting to other services. The type must be string input that can be parsed to an integer value. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +146,9 @@ Accept wildcard characters: False ``` ### -ContactEmail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an e-mail address to which external site administrators can write if problems occur when the site is being crawled. The type must be a valid e-mail address, in the form MyAddress@mycompany.com. @@ -148,8 +156,7 @@ The type must be a valid e-mail address, in the form MyAddress@mycompany.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -IgnoreSSLWarnings + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the search service will ignore Secure Sockets Layer (SSL) certificate name warnings. The default value is False. @@ -167,8 +177,7 @@ The type must be a string that can be cast to a Boolean value, for example, True ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -InternetIdentity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value that the crawler sends in the headers of its HTTP requests to sites when it fetches their pages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,22 +205,23 @@ Accept wildcard characters: False ``` ### -PerformanceLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the relative number of threads for the crawl component performance. The type must be one of the following values: Reduced, PartlyReduced, or Maximum. The default value is Maximum. - + * Reduced: Total number of threads = number of processors, Max Threads/host = number of processors. Threads are assigned Below Normal priority. - + * Partly Reduced: Total number of threads = 16 times the number of processors , Max Threads/host = 8 plus the number of processors. Threads are assigned Below Normal priority. - -* Maximum: Total number of threads = 32 times the number of processors, Max Threads/host = 8 plus the number of processors. Threads are assigned Normal priority. +* Maximum: Total number of threads = 32 times the number of processors, Max Threads/host = 8 plus the number of processors. Threads are assigned Normal priority. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +231,9 @@ Accept wildcard characters: False ``` ### -ProxyType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the search service uses a proxy server or connects directly when crawling content. The default value is Direct, (No proxy server is used). @@ -227,8 +242,7 @@ The type must be one of the following values: Direct or Proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -238,17 +252,18 @@ Accept wildcard characters: False ``` ### -ServiceAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user account or service account to use for running the Office Server Search service. When this parameter is used, the ServicePassword parameter must also be specified. The type must be a valid account name on the domain, in the form Domain\user name or user name. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -258,6 +273,9 @@ Accept wildcard characters: False ``` ### -ServicePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the service account specified in ServiceAccount. The type must contain the domain password to the account specified in the ServiceAccount parameter. @@ -265,8 +283,7 @@ The type must contain the domain password to the account specified in the Servic ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,6 +293,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -283,7 +303,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplication.md index 60a60badd..8b29f3493 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a search service application for a farm. - ## SYNTAX ``` @@ -35,30 +34,29 @@ A search application can include multiple search service applications. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -VerboseQueryMonitoring True ``` This example turns on verbose query logging in the default search service application named Search Service Application. - ## PARAMETERS ### -AdminApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the application pool for the administrative web service for the search service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AdminAppPool1); or an instance of a valid IISWebServiceApplicationPool object. - ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -68,16 +66,17 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an application pool for the search service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPool1); or an instance of a valid IISWebServiceApplicationPool object. - ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,12 +97,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,15 +110,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,15 +129,16 @@ Accept wildcard characters: False ``` ### -DatabaseName -This parameter is obsolete and has no function. -You should not use this parameter. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +This parameter is obsolete and has no function. +You should not use this parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +148,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword -Specifies the password for the user ID that is used for accessing the web service administration database on SQL Server. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the password for the user ID that is used for accessing the web service administration database on SQL Server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -163,16 +166,17 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the web service administration database. The type must be a valid SQL Server host name, for example, SQLServerHost1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,16 +186,17 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user ID to use for accessing the web service administration database. The type must be a valid user name, for example, WebAdminUserDB1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,16 +206,17 @@ Accept wildcard characters: False ``` ### -DefaultContentAccessAccountName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account ID to use for accessing content. The type must be a valid user name, for example, ContentAccessUser1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -220,16 +226,17 @@ Accept wildcard characters: False ``` ### -DefaultContentAccessAccountPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the content access account. The type must be a valid password. - ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -239,15 +246,16 @@ Accept wildcard characters: False ``` ### -DefaultSearchProvider -Specifies the search application type to be used for this application. -This parameter has been deprecated for SharePoint Server. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the search application type to be used for this application. +This parameter has been deprecated for SharePoint Server. ```yaml Type: SearchProvider Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -257,15 +265,16 @@ Accept wildcard characters: False ``` ### -DiacriticSensitive + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the search application respects diacritics (for example, ä). The default value is false. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -275,16 +284,17 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL instance for the failover database server. The type must be a valid SQL Server instance name, for example, SQLServerHost1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,16 +304,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -313,17 +324,18 @@ Accept wildcard characters: False ``` ### -VerboseQueryMonitoring + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables verbose query logging. The default value is False. The type must be a string that can be cast to a Boolean value, for example, True or False. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -333,15 +345,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplicationProxy.md index ed2d2fcb9..cb6e25252 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceApplicationProxy.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a search service application proxy. - ## SYNTAX ``` @@ -30,20 +29,21 @@ One search service application proxy exists for each search application on a far For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchServiceApplicationProxy -Identity SsaProxy | Set- SPEnterpriseSearchServiceApplicationProxy -Name ContosoSearchProxy ``` This example sets the display name of a search service application proxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specified the search service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the search application proxy to retrieve. The type must be a valid string, for example, SearchAppProxy1. @@ -108,8 +114,7 @@ The type must be a valid string, for example, SearchAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceInstance.md index 7a0458d2d..8ad773ce2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchServiceInstance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a search service instance. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet updates properties of the search service instance for a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchServiceInstance -Identity $si -DefaultIndexLocation F:\SearchIndex @@ -42,16 +40,17 @@ Sets the default index location to F:\SearchIndex. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,16 +60,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,14 +80,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +98,9 @@ Accept wildcard characters: False ``` ### -DefaultIndexLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + > [!NOTE] > On SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 this parameter is obsolete and has no function. You should not use this parameter. @@ -108,12 +112,10 @@ The type must be a valid path in either of the following forms: - \\\\server_name\folder_name - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,15 +125,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchTopology.md index 80e1a2e6e..caca72641 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPEnterpriseSearchTopology.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Activates a given search topology. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet enables the search topology with the given identity, marking the cur For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e @@ -41,8 +39,7 @@ Set-SPEnterpriseSearchTopology -Identity $topology -SearchApplication $ssa This example enables a search topology with the Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa | ?{$_.State -eq 'Inactive'} @@ -54,13 +51,15 @@ This example retreives an inactive topology and sets it to the active topology. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search topology to enable. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search application to which the search topology will belong. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -116,8 +122,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +142,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelBIServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelBIServer.md index 23000744d..d2d088de4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelBIServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelBIServer.md @@ -27,10 +27,9 @@ Set-SPExcelBIServer [-Identity] [-AssignmentCollection ## DESCRIPTION Use the Set-SPExcelBIServer cmdlet to specify a description for an existing BI server for Excel Services. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} Set-SPExcelBIServer -Identity "ExcelServices" -ExcelServiceApplication $sa @@ -39,6 +38,9 @@ Set-SPExcelBIServer -Identity "ExcelServices" -ExcelServiceApplication $sa ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +48,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -57,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the description of the Analysis server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -105,13 +112,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the ExcelServiceApplication identity. ```yaml Type: SPExcelBIServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 0 @@ -121,13 +130,15 @@ Accept wildcard characters: False ``` ### -ServerId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + The name of the Analysis Services server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -137,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -144,7 +158,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataConnectionLibrary.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataConnectionLibrary.md index 2030ebeb9..ad64d3492 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataConnectionLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataConnectionLibrary.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a data connection library for Excel Services Application. - ## SYNTAX ``` @@ -36,28 +35,28 @@ However, using a data connection library to load data connections provides an ad For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "https://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary -Description "This is the DCL where all the connections to the sales data are stored ``` This example sets a display description for the entry https://portal/site/salesDCL in the list of trusted data connection libraries (DCLs) that is on the Excel Services Application Web service application named MyExcelService. - -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataConnectionLibrary | where {$_.address -eq "https://portal/site/salesDCL" } | Set-SPExcelDataConnectionLibrary -Address "https://portal/site/salesDCL ``` This example updates the address of the data connection library for the entry https://portal/test/site/salesDCL to https://portal/site/salesDCL in the list of trusted data connection libraries, which is on the Excel Services Application Web service application named MyExcelService. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the DataConnectionLibrary object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection library (for example, DataConnectionLib1); a valid URL, in the form https://server_name; or an instance of a valid SPExcelDCL object. @@ -65,8 +64,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelDCLPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -76,6 +74,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains SPExcelDataConnectionLibrary list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -83,8 +84,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -94,6 +94,9 @@ Accept wildcard characters: False ``` ### -Address + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the address of the data connection library. The address must be unique in the list of trusted data connection libraries. @@ -102,8 +105,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -113,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +129,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -135,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -152,6 +158,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the data connection library. The type must a valid a string; for example, "This is the data connection library where all the connections to the sales data are stored". @@ -159,8 +168,7 @@ The type must a valid a string; for example, "This is the data connection librar ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -170,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -177,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataProvider.md index ff805ab8b..e2feff289 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelDataProvider.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a safe data provider for Excel Services Application. - ## SYNTAX ``` @@ -26,28 +25,29 @@ Set-SPExcelDataProvider [-Identity] ## DESCRIPTION The `Set-SPExcelDataProvider` cmdlet sets the properties of a data provider that is stored in the list of safe data providers. -Excel Services Application refreshes external data connections only if the data provider for that connection is in the list of safe data providers. +Excel Services Application refreshes external data connections only if the data provider for that connection is in the list of safe data providers. Excel Services Application include a set of common data providers in this list. Therefore, using cmdlets to modify safe data providers is typically an operation of custom data connection scenarios. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` -$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB" } +$provider = Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelDataProvider | where {$_.ProviderID -eq "SQLOLEDB" } Set-SPExcelDataProvider $provider -Description "The SQLOLEDB provider description has changed." $provider | format-table ``` This example retrieves the SQLOLEDB data provider from the list of safe data providers that is on the Excel Services Application Web service application named MyExcelService, as an object, adds a new display description and then displays the provider output in a Command Prompt window, formatted as a table. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelDataProvider object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SPExcelDataProvider object. @@ -55,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelDataProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a display description for the data provider. The type must a valid a string; for example, this is a custom OLEDB provider. @@ -112,8 +118,7 @@ The type must a valid a string; for example, this is a custom OLEDB provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the name of the data provider. This ID should be present in the connection strings generated by this data provider and the ID must be unique for the data provider type. @@ -131,8 +139,7 @@ The type must a valid name of a provider; for example, CustomOLEDB. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -ProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the supported type of the data provider to set. The type must be one of the following: OleDb, Odbc, or OdbcDsn. @@ -149,8 +159,7 @@ The type must be one of the following: OleDb, Odbc, or OdbcDsn. ```yaml Type: DataProviderType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -160,6 +169,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -167,7 +179,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelFileLocation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelFileLocation.md index dfd1c53e7..09697e3f0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelFileLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelFileLocation.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a trusted file location for Excel Services Application. - ## SYNTAX ``` @@ -40,28 +39,28 @@ The properties that are used by the trusted file location are determined by comp For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Get-SPExcelFileLocation -ExcelServiceApplication "My Excel Service" | where { $_.externaldataallowed -eq "DclAndEmbedded"} | Set-SPExcelFileLocation -ExernalDataAllowed Dcl ``` This example gets every trusted file location for the Excel Services Application Web service application named My Excel Service that allows data connections to load from workbook files and specifies that the locations must use a data connection library to load data connections. - -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication | Get-SPExcelFileLocation | where {$_.Address -eq "https://"} | Set-SPExcelFileLocation -Description "This is the default trusted file location for Excel Services Application. It allows any file from anywhere in SharePoint to load." ``` This example changes the description of the default file location for every Excel Services Application Web service application in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the FileLocation object to update. The name must be unique in the list of file locations. @@ -70,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelFileLocationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -81,6 +79,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -88,8 +89,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -99,6 +99,9 @@ Accept wildcard characters: False ``` ### -AbortOnRefreshOnOpenFail + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that the load of a Excel Services Application file automatically fails if an automatic data refresh operation fails when the file is opened. The load is failed only if the following conditions are true: @@ -108,8 +111,7 @@ The load is failed only if the following conditions are true: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -119,6 +121,9 @@ Accept wildcard characters: False ``` ### -Address + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + System.String Specifies a Web folder, or file directory from which Excel Services Application can load workbooks. @@ -128,8 +133,7 @@ The type must be a valid URL, in the form https://myPortal/myTeam; or a valid UN ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -139,6 +143,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -150,8 +157,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -161,6 +167,9 @@ Accept wildcard characters: False ``` ### -AutomaticVolatileFunctionCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations. Valid values include: @@ -175,8 +184,7 @@ The type must be the integers -1 or 0, or an integer value in the range of 1 to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -186,6 +194,9 @@ Accept wildcard characters: False ``` ### -ChartAndImageSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum size, in megabytes, of a chart or image that can be opened. The default value is 1. @@ -194,8 +205,7 @@ The type must be a valid integer greater than 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -205,6 +215,9 @@ Accept wildcard characters: False ``` ### -ConcurrentDataRequestsPerSessionMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of concurrent external data requests allowed in each session. If a session must issue more than this number of requests, additional requests must be queued. The scope of this setting is the logical server. @@ -215,8 +228,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -226,6 +238,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -233,7 +248,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -243,6 +257,9 @@ Accept wildcard characters: False ``` ### -DefaultWorkbookCalcMode + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the calculation mode of workbooks. All of the settings except the File setting override the workbook settings. If this parameter is changed, it is applied to all new sessions on Excel Services Application when the ConfigDB properties cache is refreshed. @@ -253,8 +270,7 @@ The type must be one of the following: File, Manual, Auto, or AutoDataTables. ```yaml Type: DefaultWorkbookCalcMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -264,6 +280,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a friendly description for the new file location. The type must be a valid string; for example, this is the file location of the monthly sales reports. @@ -271,8 +290,7 @@ The type must be a valid string; for example, this is the file location of the m ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -282,13 +300,15 @@ Accept wildcard characters: False ``` ### -DisplayGranularExtDataErrors + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays granular error messages for external data failures for files in this location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -298,6 +318,9 @@ Accept wildcard characters: False ``` ### -ExternalDataAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the type of external data access allowed for workbooks: None specifies that data refresh is disabled. Dcl specifies that data is refreshed only when it uses a connection file in a trusted data connection library. @@ -311,8 +334,7 @@ The type must be one of the following: None, Dcl, or DclAndEmbedded. ```yaml Type: AllowExternalData Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -322,14 +344,16 @@ Accept wildcard characters: False ``` ### -IncludeChildren + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Indicates that subordinate URLs, directories and libraries are trusted. For example, if the trusted file location is https://portal, and IncludeChildren is true, then https://portal/subSite is also trusted, as is any subURL under the URL specified in Address. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -339,6 +363,9 @@ Accept wildcard characters: False ``` ### -LocationType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + The type of location. LocationType indicates how Excel Services Application retrieves files from that location specified in Address. The default value is SharePoint. @@ -348,8 +375,7 @@ The type must be one of the following: SharePoint, UNC, or HTTP. ```yaml Type: LocationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -359,6 +385,9 @@ Accept wildcard characters: False ``` ### -ManualExtDataCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that Excel Services Application waits before re-issuing a manual, or user-initiated, external data request. During this period, the results from the previous external data request may be returned from an external data cache. @@ -373,8 +402,7 @@ The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -384,6 +412,9 @@ Accept wildcard characters: False ``` ### -NewWorkbookSessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a session for a new, unsaved, workbook will remain active on Excel Services Application with no user activity. The default value 1800. Valid values include the following: @@ -399,8 +430,7 @@ The type must be -1, 0, or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -410,6 +440,9 @@ Accept wildcard characters: False ``` ### -PeriodicExtDataCacheLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that Excel Services Application waits before re-issuing an on-open or periodic (that is, automatic) external data request. During this period, the results from the previous external data request may be returned from an external data cache. A value -1 specifies to never refresh after the first query. @@ -421,8 +454,7 @@ The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -432,6 +464,9 @@ Accept wildcard characters: False ``` ### -RequestDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum duration, in seconds, for a single request in a session. After this time elapses the request is timed out. @@ -442,8 +477,7 @@ The default value is 300. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -453,6 +487,9 @@ Accept wildcard characters: False ``` ### -RESTExternalDataAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections. The RESTExternalDataAllowed parameter has no effect if the External DataAllowed parameter is set to None. @@ -460,8 +497,7 @@ The RESTExternalDataAllowed parameter has no effect if the External DataAllowed ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -471,6 +507,9 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a session will remain active on Excel Services Application with no user activity. The default is 300 seconds. The default value is 300. @@ -487,8 +526,7 @@ The type must be -1, 0, or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -498,6 +536,9 @@ Accept wildcard characters: False ``` ### -ShortSessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the time, in seconds, that a user has to make the initial interaction with a spreadsheet. After this time has elapsed, if the user is not active, then the session is closed. The value must always be less than SessionTimeout. @@ -509,8 +550,7 @@ The type must be -1 or an integer in the range of 1 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -520,13 +560,15 @@ Accept wildcard characters: False ``` ### -UdfsAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that user-defined functions can be called by workbooks loaded from the trusted file location that is specified in Address. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -536,14 +578,16 @@ Accept wildcard characters: False ``` ### -WarnOnDataRefresh + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that a warning is displayed to the user on the first refresh of data for the workbook. The default value is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -553,6 +597,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -560,7 +607,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -570,6 +616,9 @@ Accept wildcard characters: False ``` ### -WorkbookSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum size, in megabytes, of a workbook that can be loaded. The default value is 10. @@ -578,8 +627,7 @@ The type must be an integer value in the range of 1 to 2000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -589,15 +637,17 @@ Accept wildcard characters: False ``` ### -ChartRenderDurationMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + The maximum time (in seconds) spent rendering any single chart. -Valid values: -1 (no limit); from 1 through 2073600 (24 days). +Valid values: -1 (no limit); from 1 through 2073600 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelServiceApplication.md index d6d9e4077..20d129884 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets global properties for Excel Services Application. - ## SYNTAX ### ExistingTargetApplicationParameterSet @@ -47,15 +46,14 @@ Set-SPExcelServiceApplication [[-Identity] ] ``` ## DESCRIPTION -The `Set-ExcelServiceApplication` cmdlet changes global runtime properties for Excel Services Application. +The `Set-ExcelServiceApplication` cmdlet changes global runtime properties for Excel Services Application. Changes to properties that are made by using this cmdlet affect all machines in the farm that are running an instance of the specified Excel Services Application Web service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} Set-SPExcelServiceApplication -Identity $sa -SessionsPerUserMax 10 @@ -63,18 +61,19 @@ Set-SPExcelServiceApplication -Identity $sa -SessionsPerUserMax 10 This example sets the Excel Services Application to enable each user to open no more than 10 sessions at one time on a back-end application server that runs Excel Services Application. - -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'} Set-SPExcelServiceApplication -Identity $sa -PrivateBytesMax -1 ``` This example sets the maximum number of private bytes of memory on the computer to a value of -1, which indicates that Excel Services Application will consume 50 percent of the available memory resources. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelServiceApplication object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -82,8 +81,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: 1 @@ -93,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +105,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -115,14 +115,16 @@ Accept wildcard characters: False ``` ### -CachingOfUnusedFilesEnable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. The default is true when the parameter is not specified on the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -132,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -149,13 +153,15 @@ Accept wildcard characters: False ``` ### -CrossDomainAccessAllowed + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -165,6 +171,9 @@ Accept wildcard characters: False ``` ### -EncryptedUserConnectionRequired + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Requires that encryption is used between the end-user and the server running Excel Services Application. The scope of this setting is the logical server. The default value is None. @@ -174,8 +183,7 @@ The type must be one of the following: None or Connection. ```yaml Type: EncryptedConnectionMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -185,6 +193,9 @@ Accept wildcard characters: False ``` ### -ExternalDataConnectionLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of seconds that an external data connection can remain open in the connection pool. Valid values are: @@ -198,8 +209,7 @@ The default value is 1800. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -209,6 +219,9 @@ Accept wildcard characters: False ``` ### -FileAccessMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the authentication method that Excel Services Application uses to retrieve files. UseFileAccessAccount specifies that all workbooks always use the credentials of the service account running Excel Services Application. UseImpersonation specifies that Excel Services Application retrieves the workbook files as the user who makes the request. @@ -219,8 +232,7 @@ The type must be one of the following: UseImpersonation or UseFileAccessAccount. ```yaml Type: FileAccessMethod Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -230,6 +242,9 @@ Accept wildcard characters: False ``` ### -LoadBalancingScheme + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. The default value is WorkbookURL. @@ -238,8 +253,7 @@ The type must be one of the following: RoundRobin, Local, or WorkbookURL. ```yaml Type: LoadBalancingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -249,6 +263,9 @@ Accept wildcard characters: False ``` ### -MemoryCacheThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. When the memory cache threshold is exceeded, cached objects that are not currently in use are released. Setting this value to 0 disables caching of inactive objects. @@ -259,8 +276,7 @@ The type must be an integer in the range of 0 to 95. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -270,6 +286,9 @@ Accept wildcard characters: False ``` ### -PrivateBytesMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. When set to -1, the maximum private bytes defaults to 50 percent of physical memory on the computer. Valid values include -1 for no limit, and any positive integer. @@ -280,8 +299,7 @@ The type must be -1 or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -291,6 +309,9 @@ Accept wildcard characters: False ``` ### -SessionsPerUserMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of sessions allowed for a user. If a user reaches this maximum the oldest session is deleted when a new session is started. Valid values include -1 for no limit, and any positive integer. @@ -301,8 +322,7 @@ The type must be -1 or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -312,6 +332,9 @@ Accept wildcard characters: False ``` ### -SiteCollectionAnonymousSessionsMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum number of anonymous sessions allowed per site collection. A value of 0 specifies that no anonymous sessions are allowed. Valid values include -1 for no limit, 0 to disable the setting, or any positive integer. @@ -322,8 +345,7 @@ The type must be -1, 0, or any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -333,13 +355,15 @@ Accept wildcard characters: False ``` ### -TerminateProcessOnAccessViolation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Terminates Excel Services Application when an access violation occurs in the process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -349,6 +373,9 @@ Accept wildcard characters: False ``` ### -ThrottleAccessViolationsPerSiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook's site collection are blocked from loading for the specified period (in seconds). Existing sessions for files on that site collection are unaffected. Valid values include 0 to disable the setting, and the range of 1 to 2073600 seconds (24 days). @@ -359,8 +386,7 @@ The type must be an integer value in the range of 0 to 2073600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -370,6 +396,9 @@ Accept wildcard characters: False ``` ### -UnattendedAccountApplicationId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. The secure storage service is contacted when this parameter is set and specific error cases occur. Valid values are alphanumeric strings with a maximum of 256 characters. @@ -383,8 +412,7 @@ An unattended account is required when workbook connections specify None for aut ```yaml Type: String Parameter Sets: ExistingTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -394,6 +422,9 @@ Accept wildcard characters: False ``` ### -UnusedObjectAgeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. Valid values include -1 for no maximum setting, and a positive integer in the range of 1 to 34560 minutes (24 days). The default value is -1. @@ -403,8 +434,7 @@ The type must be -1, or an integer in the range of 1 to 34560. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -414,6 +444,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -421,7 +454,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -431,6 +463,9 @@ Accept wildcard characters: False ``` ### -WorkbookCache + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application. If no value is specified, the default value is a subdirectory in the system temporary directory. @@ -443,8 +478,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -454,6 +488,9 @@ Accept wildcard characters: False ``` ### -WorkbookCacheSizeMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the maximum allowable size, in megabytes, of an individual session. The default value is 0. @@ -462,8 +499,7 @@ The type must be any positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -473,13 +509,15 @@ Accept wildcard characters: False ``` ### -UnattendedServiceAccount -The Unattended Service Account is a single account that all workbooks can use to refresh data. This account is required to refresh data when workbook connections specify "Use the Unattended Service Account" without using Windows Credentials. + +> Applicable: SharePoint Server 2013 + +The Unattended Service Account is a single account that all workbooks can use to refresh data. This account is required to refresh data when workbook connections specify "Use the Unattended Service Account" without using Windows Credentials. ```yaml Type: PSCredential Parameter Sets: NewTargetApplicationParameterSet -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -489,15 +527,17 @@ Accept wildcard characters: False ``` ### -UseEffectiveUserName -The UseEffectiveUserName property is an alternative to Windows delegation for allowing users to securely access Analysis Services data. -The setting will only impact external data connections based on Analysis Services workbook connections with an authentication setting of "Use the authenticated user's account". +> Applicable: SharePoint Server 2013 + +The UseEffectiveUserName property is an alternative to Windows delegation for allowing users to securely access Analysis Services data. + +The setting will only impact external data connections based on Analysis Services workbook connections with an authentication setting of "Use the authenticated user's account". ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -507,13 +547,15 @@ Accept wildcard characters: False ``` ### -WorkbookModelUsageTracker + +> Applicable: SharePoint Server 2013 + {{Fill WorkbookModelUsageTracker Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelUserDefinedFunction.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelUserDefinedFunction.md index eb6b3fc74..8e92e2f24 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelUserDefinedFunction.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPExcelUserDefinedFunction.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a user-defined function in Excel Services Application. - ## SYNTAX ``` @@ -26,7 +25,7 @@ Set-SPExcelUserDefinedFunction [-Identity] ``` ## DESCRIPTION -The `Set-SPExcelUserDefinedFunction` cmdlet sets properties of a user-defined function assembly. +The `Set-SPExcelUserDefinedFunction` cmdlet sets properties of a user-defined function assembly. Excel Services Application uses only user-defined functions that have an entry in the user-defined function list. User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. The assemblies can perform custom logic or other actions, such as refresh data. @@ -34,28 +33,28 @@ Windows PowerShell cmdlets operate on the entries in the user-defined function l For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------------- +### EXAMPLE 1 ``` Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF" ``` This example changes the description of the user-defined function (UDF) to the UDF SampleCompany.SampleApplication.SampleUdf file for the Excel Services Application Web service application named My Excel Service. - -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ``` Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $false ``` This example disables the sample UDF SampleCompany.SampleApplication.SampleUdf file from the Excel Services Application named My Excel Service. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the SPExcelUserDefinedFunction object to update. The type must be a valid name of the code assembly; for example, SampleCompany.SampleApplication.SampleUdf; or an instance of a valid SPExcelUDF object. @@ -63,8 +62,7 @@ The type must be a valid name of the code assembly; for example, SampleCompany.S ```yaml Type: SPExcelUDFPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: 1 @@ -74,6 +72,9 @@ Accept wildcard characters: False ``` ### -ExcelServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the Excel Services Application Web service application that contains the SPExcelUserDefinedFunction list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. @@ -81,8 +82,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPExcelServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: True Position: Named @@ -92,17 +92,18 @@ Accept wildcard characters: False ``` ### -Assembly + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the strongly-typed name of the assembly. The name must be unique in the list of user-defined functions and cannot be more than 4096 alphanumeric characters long. The type must be a string of alphanumeric characters; for example, SampleCompany.SampleApplication.SampleUdf, C:\UDFs\SampleUdf.dll, or \\\\MyNetworkServer\UDFs\SampleUdf.dll. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -112,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssemblyLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies the location where the assembly is stored. The type must be one of the following: GAC or LocalFile. @@ -119,8 +123,7 @@ The type must be one of the following: GAC or LocalFile. ```yaml Type: AssemblyLocation Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -130,6 +133,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -141,8 +147,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -152,6 +157,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named @@ -169,6 +176,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies a display description for the user-defined function. The name cannot be more than 4096 alphanumeric characters long. @@ -177,8 +187,7 @@ The type must be a string of alphanumeric characters; for example, this is the u ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -188,13 +197,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Activates the user-defined function for use with Excel Services Application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -204,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -211,7 +225,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPFarmConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPFarmConfig.md index 404742a22..91634329b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPFarmConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPFarmConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets a global property or a collection of global properties for the local farm. - ## SYNTAX ``` @@ -39,10 +38,9 @@ The parameter name added to the PSCustomObject object must match exactly the inp For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE-------------------------- +### EXAMPLE ``` Set-SPFarmConfig -WorkflowBatchSize 50 ``` @@ -52,6 +50,9 @@ This example sets the WorkflowBatdhSize to 50. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -59,8 +60,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -70,6 +70,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -77,7 +80,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -DataFormWebPartAutoRefreshEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether any DataFormWebPart on any page in this farm is allowed to periodically refresh its contents asynchronously (after the page has finished rendering). When set to false, all DataFormWebParts will ignore the automatic refresh interval provided in Web Part properties. @@ -94,8 +99,7 @@ When set to false, all DataFormWebParts will ignore the automatic refresh interv ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,13 +109,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the deletion or updating of the service connection point. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +127,15 @@ Accept wildcard characters: False ``` ### -InstalledProductsRefresh + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Updates the current machine license state with the list of products that are installed in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +145,9 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPointBindingInformation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds or updates the service connection point for the current farm in Active Directory Domain Service (AD DS). The type must be an array of strings that are key value pairs that will be added to the service connection point. @@ -144,8 +155,7 @@ The type must be an array of strings that are key value pairs that will be added ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +165,15 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPointDelete + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Delete the service connection point for the current farm in AD DS. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +183,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +193,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -188,6 +202,9 @@ Accept wildcard characters: False ``` ### -WorkflowBatchSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the paging size for events delivered to a single workflow instance. For each request, the events are streamed out 100 at a time. @@ -198,8 +215,7 @@ Throttle will override batch size; if the workflow instance cannot be started or ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +225,9 @@ Accept wildcard characters: False ``` ### -WorkflowEventDeliveryTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time as an integer in which a workflow job must run without the job timing out. If the workflow job does time out, it gets put back in the queue to be run again. @@ -219,8 +238,7 @@ Any workflow job that does time out is placed back in the queue to run again.The ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +248,15 @@ Accept wildcard characters: False ``` ### -WorkflowPostponeThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of workflows that can be running in IIS against a content database at a time before new workflow instances get postponed into a queue. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -246,13 +266,15 @@ Accept wildcard characters: False ``` ### -ASPScriptOptimizationEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if ASP Script optimization is enabled. The default value is false (off). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -262,13 +284,15 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPathIsImmutable + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies if the `UserAccountDirectoryPath` property on an `SPSite` object is immutable. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -278,13 +302,15 @@ Accept wildcard characters: False ``` ### -DefaultActivateOnSiteMasterValue + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to activate site master as default. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,13 +320,15 @@ Accept wildcard characters: False ``` ### -MaxSiteSubscriptionSettingsValueLength + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum size of a SiteSubscription property value. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -310,13 +338,15 @@ Accept wildcard characters: False ``` ### -MaxTenantStoreValueLength + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum size of a Tenant Store property value. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -326,13 +356,15 @@ Accept wildcard characters: False ``` ### -SiteMasterMode + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies if site master mode is turned on or off. The default value is off. ```yaml Type: SPSiteMasterMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,6 +374,9 @@ Accept wildcard characters: False ``` ### -SiteMasterValidationIntervalInHours + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Determines the length of time, in hours, to validate the Site Master. The default value is 24. @@ -349,8 +384,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPIRMSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPIRMSettings.md index 1ed8fbd14..076137fa0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPIRMSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPIRMSettings.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the Information Rights Management (IRM) settings. - ## SYNTAX ### UseSpecifiedCertificateUrl @@ -41,24 +40,23 @@ Use the `Set-SPIRMSettings` cmdlet to set the Information Rights Management (IRM For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ``` Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery ``` This example enables IRM for the farm and configures it to use the default RMS server configured in Active Directory. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ``` Set-SPIRMSettings -RmsEnabled -CertificateServerUrl https://myrmsserver ``` This example enables IRM for the farm and specifies the URL of the RMS server to use. -### --------------EXAMPLE 3------------ +### EXAMPLE 3 ``` site = Get-SPSite http://myspserver $subscription = $site.SiteSubscription @@ -67,24 +65,25 @@ Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServer This example enables IRM for the specified tenant and specifies the URL of the RMS server to use. -### --------------EXAMPLE 4------------ +### EXAMPLE 4 ``` Set-SPIRMSettings -RmsEnabled:$false ``` This example disables IRM for the farm. - ## PARAMETERS ### -CertificateServerUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the address of the RMS certificate server to use for the tenant. ```yaml Type: Uri Parameter Sets: UseSpecifiedCertificateUrl -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,6 +93,9 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not IRM is enabled in the tenant. The default value is false. @@ -101,8 +103,7 @@ The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -112,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +137,16 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +166,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -168,6 +175,9 @@ Accept wildcard characters: False ``` ### -ServiceAuthenticationCertificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service authentication certificate. If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. @@ -176,8 +186,7 @@ If the parameter is not specified, the local farm connects to RMS server using i ```yaml Type: X509Certificate2 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +196,9 @@ Accept wildcard characters: False ``` ### -SubscriptionScopeSettingsEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not IRM can be configured at the site subscription scope. Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope. @@ -194,8 +206,7 @@ Site subscriptions can only configure custom IRM settings if IRM is enabled at t ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -205,13 +216,15 @@ Accept wildcard characters: False ``` ### -UseActiveDirectoryDiscovery + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the domain. ```yaml Type: SwitchParameter Parameter Sets: UseServiceDiscovery -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -228,7 +244,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -238,6 +253,9 @@ Accept wildcard characters: False ``` ### -UseOauth + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether OAuth should be used. The valid values are True and False. @@ -245,8 +263,7 @@ The valid values are True and False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormTemplate.md index f3d301467..8b872acbd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormTemplate.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a InfoPath form template. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPInfoPathFormsTemplate` cmdlet modifies the category of an InfoPath fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Set-InfoPathFormTemplate -Identity "Sample.xsn" -Category "WorkFlowCategory" ``` This example modifies the category property of a form template for a specified name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category of the form template. The category name can have a maximum of 255 characters. @@ -91,8 +95,7 @@ The type must be a valid name of a form template category; for example, FormTemp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormsService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormsService.md index f1a94aed9..76a0f0f8a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormsService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathFormsService.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets parameters for InfoPath Forms Services in SharePoint Server. - ## SYNTAX ``` @@ -35,17 +34,16 @@ The `Set-SPInfoPathFormsService` cmdlet modifies the settings for InfoPath Forms For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Set-SPInfoPathFormsService -AllowUserFormBrowserEnabling $true -AllowUserFormBrowserRendering $false ``` This example modifies the AllowUserFormBrowserEnabling and AllowUserFormBrowserRendering parameter values. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Set-SPInfoPathFormsService -AllowViewState $true -ViewStateThreshold 40961 ``` @@ -55,6 +53,9 @@ This example modifies the AllowViewState and ViewStateThreshold parameter values ## PARAMETERS ### -ActiveSessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the duration, in minutes, that a form's session state can remain active. The default value is 1440. @@ -63,8 +64,7 @@ The type must be a non-negative integer value in the range from 0 through 999,99 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -74,6 +74,9 @@ Accept wildcard characters: False ``` ### -AllowEmbeddedSqlForDataConnections + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a value that indicates whether embedded SQL authentication can be used by browser-enabled InfoPath form templates. The type must be one of the following values: True, False (default) @@ -81,8 +84,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +94,9 @@ Accept wildcard characters: False ``` ### -AllowUdcAuthenticationForDataConnections + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that authentication information in a universal data connection (.udcx file) can be used. The type must be one of the following values: True (default), False @@ -99,8 +104,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +114,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormBrowserEnabling + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that users can browser enable form templates that do not contain form code, require full trust, enable rendering on a mobile device, or use a data connection managed by a server administrator. The type must be one of the following values: True (default), False @@ -117,8 +124,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +134,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormBrowserRendering + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that browser-enabled form templates will be rendered by InfoPath Forms Services. The type must be one of the following values: True (default), False @@ -135,8 +144,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +154,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormCrossDomainDataConnections + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that data connections to data sources located in a different domain can be queried. The type must be one of the following values: True, False (default) @@ -153,8 +164,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +174,9 @@ Accept wildcard characters: False ``` ### -AllowViewState + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines the location to store form session state: View state when True, or Session State Service when False. The type must be one of the following values: True, False (default) @@ -171,8 +184,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +194,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -193,8 +208,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +218,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -211,7 +228,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -221,6 +237,9 @@ Accept wildcard characters: False ``` ### -DefaultDataConnectionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the default data connection timeout in milliseconds. The default value is 10000 (10 seconds). @@ -229,8 +248,7 @@ The type must be a non-negative integer and less than or equal to the value set ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +258,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath Forms Services service to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an InfoPath Forms Services service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -247,8 +268,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -258,6 +278,9 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionResponseSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum size allowed for a data connection response. The default value is 15000 kilobytes (KB). @@ -266,8 +289,7 @@ The type must be a non-negative integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -277,14 +299,16 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionRoundTrip + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a threshold, in milliseconds, for the maximum time it takes from the start of a data request to the return of the data request on the server (the data connection round trip). If the data connection round trip time exceeds this threshold, an event is logged in the Operational log. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,6 +318,9 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum data connection timeout in milliseconds. The default value is 20000 (20 seconds). @@ -302,8 +329,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -313,6 +339,9 @@ Accept wildcard characters: False ``` ### -MaxFormLoadTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a threshold, in milliseconds, for maximum form load time. If form load time exceeds this threshold, an event is logged in the Operational log. @@ -321,8 +350,7 @@ The MaxFormLoadTime parameter measures the time it takes for a form to open, sta ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -332,6 +360,9 @@ Accept wildcard characters: False ``` ### -MaxPostbacksPerSession + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value of the maximum postbacks that an instance of a browser-enabled InfoPath form template can make to the InfoPath Forms Services service. The default value is 20. @@ -340,8 +371,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -351,6 +381,9 @@ Accept wildcard characters: False ``` ### -MaxUserActionsPerPostback + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum user actions per postback. The default value is 200. @@ -359,8 +392,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -370,6 +402,9 @@ Accept wildcard characters: False ``` ### -MemoryCacheSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the size, in megabytes (MB), of the cache for solutions in memory. The default value is 250 MB. @@ -377,8 +412,7 @@ The default value is 250 MB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -388,6 +422,9 @@ Accept wildcard characters: False ``` ### -RequireSslForDataConnections + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Sockets Layer (SSL) requirement value. If data connections in browser-enabled form templates require basic authentication or digest authentication, a password is sent over the network. Set this value to True to require an SSL-encrypted connection for these authentication types. @@ -397,8 +434,7 @@ The type must be one of the following values: True (default), False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -408,6 +444,9 @@ Accept wildcard characters: False ``` ### -ViewStateThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum size in kilobytes of the session state when stored in the form view. The default value is 40. @@ -416,8 +455,7 @@ The type must be a non-negative integer and less than or equal to 99,999,999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -427,6 +465,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -434,7 +475,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -444,6 +484,9 @@ Accept wildcard characters: False ``` ### -MaxSizeOfUserFormState + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the value of the maximum size in kilobytes of session state an instance of a browser-enabled InfoPath form template can use. The default value is 4096. The type must be a non-negative integer and less than or equal to 999999. @@ -451,8 +494,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathWebServiceProxy.md index ab94db557..24fba63fb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathWebServiceProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInfoPathWebServiceProxy.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets parameters for an existing SharePoint Web service application. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPInfoPathWebServiceProxy` cmdlet configures exposed parameters for an For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Set-SPInfoPathWebServiceProxy -Identity "https://server_name" -AllowWebServiceProxy $true ``` This example sets the Web service proxy for a Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web service application proxy to update. The type must be a valid URL, in the form https://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. @@ -50,8 +50,7 @@ The type must be a valid URL, in the form https://server_name; a valid name of a ```yaml Type: SPWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AllowForUserForms + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that a form opened in the InfoPath client can use the InfoPath Forms Services Web service proxy to connect to a Web service. This parameter can be set only when AllowWebServiceProxy is set to True. @@ -69,8 +71,7 @@ The type must be one of the following: True, False The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AllowWebServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that browser-enabled form templates can use the InfoPath Forms Services Web service proxy to connect to a Web service. The type must be one of the following: True, False The default value is False. @@ -87,8 +91,7 @@ The type must be one of the following: True, False The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +115,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInternalAppStateUpdateInterval.md index 28c8f8670..eca97e22c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInternalAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPInternalAppStateUpdateInterval.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the interval in hours between updates of the internal app state update job. - ## SYNTAX ``` @@ -29,27 +28,27 @@ The internal app state update job gets app upgrades from the internal app direct For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ``` Set-SPInternalAppStateUpdateInterval -AppStateSyncHours 24 ``` This example sets a 24-hour interval between updates of the internal app state update job. - ## PARAMETERS ### -AppStateSyncHours + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the hour for which the internal app states are updated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPLogLevel.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPLogLevel.md index 39e687514..04bd0f8c6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPLogLevel.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPLogLevel.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the trace and event level for a set of categories. - ## SYNTAX ``` @@ -30,44 +29,42 @@ If an event or trace associated with a category occurs and is equally severe or For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` set-sploglevel -TraceSeverity Monitorable ``` This example sets the TraceSeverity values for all categories to Monitorable. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Set-SPLogLevel -TraceSeverity High -EventSeverity Warning -Identity "Cat1" ``` This example sets the EventSeverity and TraceSeverity values for a single category. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` C:\PS>"Cat1", "Cat2", "Cat3" | Set-SPLogLevel -EventSeverity Error ``` This example sets the EventSeverity values for multiple categories. - -### ------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ``` Set-SPLogLevel -EventSeverity Warning -Identity "AreaName:*" ``` This example sets the EventSeverity values for all categories in the same area. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +86,9 @@ Accept wildcard characters: False ``` ### -EventSeverity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category level to be set. The category level is any one of the following values: @@ -103,8 +102,7 @@ The category level is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +112,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event-throttling setting is applied to all categories in the farm. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +131,16 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The InputObject is pipelined to the cmdlet and can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the `Get-SPLogLevel` cmdlet, modify the category values and then pipeline them into the `Set-SPLogLevel` cmdlet. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +150,9 @@ Accept wildcard characters: False ``` ### -TraceSeverity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies trace throttle to set the specified categor(ies) to. The trace log files are text files that are written to the trace log path that is defined on the Diagnostic Logging Settings page on the SharePoint Central Administration site. The type must be any one of the following values: @@ -163,8 +168,7 @@ The type must be any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPManagedAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPManagedAccount.md index 5deefabfa..7b2c9b587 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPManagedAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPManagedAccount.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the managed account. - ## SYNTAX ### NewPassword @@ -63,7 +62,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $m = Get-SPManagedAccount -Identity "DOMAINx\UserY" Set-SPManagedAccount -Identity $m -AutoGeneratePassword true @@ -71,10 +70,12 @@ Set-SPManagedAccount -Identity $m -AutoGeneratePassword true This example displays an explicit managed account if it exists and then attempts to update it to use automatically generated passwords. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -82,8 +83,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -93,13 +93,15 @@ Accept wildcard characters: False ``` ### -ConfirmPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Confirms the new password for this managed account. ```yaml Type: SecureString Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -109,13 +111,15 @@ Accept wildcard characters: False ``` ### -ExistingPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the password for this managed account to an existing value that has already been changed in Active Directory Domain Services (AD DS). ```yaml Type: SecureString Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -125,13 +129,15 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a new password for the managed account ```yaml Type: SecureString Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -141,13 +147,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a password for the managed account. ```yaml Type: SecureString Parameter Sets: NewPasswordAsParameter -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -157,6 +165,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -168,8 +179,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +189,9 @@ Accept wildcard characters: False ``` ### -AutoGeneratePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Automatically generates a new password. The type must be either of the following values: @@ -191,8 +204,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: AutoGeneratePassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +214,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -209,7 +224,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -219,6 +233,9 @@ Accept wildcard characters: False ``` ### -EmailNotification + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days before password change to begin e-mail notifications. The default value is 5. @@ -226,8 +243,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +253,9 @@ Accept wildcard characters: False ``` ### -PreExpireDays + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days before expiration to schedule password change. The default value is 2. @@ -244,8 +263,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -255,13 +273,15 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new schedule on which the password change job is to run. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -271,6 +291,9 @@ Accept wildcard characters: False ``` ### -SetNewPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the password to the new value that is passed in, and changes the value in AD DS. The type must be either of the following values: @@ -283,8 +306,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -294,6 +316,9 @@ Accept wildcard characters: False ``` ### -UseExistingPassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the password to a new value passed in where the value is already changed in AD DS. The type must be either of the following values: @@ -306,8 +331,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -317,6 +341,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -324,7 +351,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplication.md index 67690c60c..6c837c91c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a managed metadata service application. - ## SYNTAX ### NoQuota @@ -46,10 +45,9 @@ Use the `Set-SPMetadataServiceApplication` cmdlet to set the properties of a man For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` $sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' Set-SPMetadataServiceApplication -Identity $sa -HubUri 'https://sitename' -SyndicationErrorReportEnabled @@ -58,8 +56,7 @@ Set-SPMetadataServiceApplication -Identity $sa -HubUri 'https://sitename' -Syndi This example adds a content type hub to an existing managed metadata service application. It also enables error reporting when content types are imported. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` $sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' Set-SPMetadataServiceApplication -Identity $sa -AdministratorAccount 'contoso\username1' -FullAccessAccount 'contoso\AppPoolAccount1,contoso\AppPoolAccount2' -RestrictedAccount 'contoso\AppPoolAccount3,contoso\AppPoolAccount4,contoso\AppPoolAccount5' -ReadAccessAccount 'contoso\AppPoolAccount6' @@ -70,10 +67,12 @@ This example sets permissions on an existing managed metadata service applicatio If you use Windows PowerShell to set any of the account values, you should set all of them. The `Set-SPMetadataServiceApplication` cmdlet first erases all accounts, then adds the accounts that you specified. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed metadata service application to update. The type must be a valid GUID or the name of a valid managed metadata service application. @@ -81,8 +80,7 @@ The type must be a valid GUID or the name of a valid managed metadata service a ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -92,6 +90,9 @@ Accept wildcard characters: False ``` ### -AdministratorAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + A comma-separated list of user accounts or service accounts in the format \\\\ that may create and run the service application. The accounts must already exist. @@ -101,8 +102,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +112,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an existing IIS application pool in which to run the Web service for the managed metadata service application. The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool; or an instance of a valid SPServiceApplicationPool object. @@ -119,8 +122,7 @@ The value must be a GUID that is the identity of an SPServiceApplicationPool obj ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,6 +132,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -141,8 +146,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +156,9 @@ Accept wildcard characters: False ``` ### -CacheTimeCheckInterval + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the interval, in seconds, that a front-end Web server should wait before asking the application server for changes. This value is set per timer job, client application, or Web application. @@ -161,8 +168,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +178,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -189,6 +197,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If SQL authentication is to be used, either the DatabaseCredentials parameter must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. @@ -198,8 +209,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +219,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database that contains the term store for the managed metadata service application. The type must be a valid name of a SQL Server database; for example MeatadataDB1. @@ -216,8 +229,7 @@ The type must be a valid name of a SQL Server database; for example MeatadataDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,6 +239,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid name of a SQL Server database; for example SqlServerHost1. @@ -234,8 +249,7 @@ The type must be a valid name of a SQL Server database; for example SqlServerHos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +259,9 @@ Accept wildcard characters: False ``` ### -DoNotUnpublishAllPackages + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If this flag is set, the packages will not be unpublished. If the HubUri parameter is changed, all content type packages will be unpublished by default. @@ -253,8 +270,7 @@ If the HubUri parameter is not changed, this flag has no effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +280,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -271,8 +290,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -282,6 +300,9 @@ Accept wildcard characters: False ``` ### -FullAccessAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read/write permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -291,8 +312,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -302,14 +322,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new name of the service application. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -319,6 +341,9 @@ Accept wildcard characters: False ``` ### -RestrictedAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery and permission to write to open term sets and local term sets and to create new enterprise keywords. The accounts must already exist. @@ -328,8 +353,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -339,13 +363,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables reporting of errors when content types are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -355,13 +381,15 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -371,6 +399,9 @@ Accept wildcard characters: False ``` ### -MaxChannelCache + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server holds open to the application server. This value is set per timer job, client application, or Web application. @@ -380,8 +411,7 @@ The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -391,6 +421,9 @@ Accept wildcard characters: False ``` ### -ReadAccessAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read-only permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -400,8 +433,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -411,6 +443,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -418,7 +453,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -428,13 +462,15 @@ Accept wildcard characters: False ``` ### -DisablePartitionQuota + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, disables the partition quota. ```yaml Type: SwitchParameter Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -444,13 +480,15 @@ Accept wildcard characters: False ``` ### -GroupsPerPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, sets the maximum number of groups per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -460,13 +498,15 @@ Accept wildcard characters: False ``` ### -LabelsPerPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, sets the maximum number of labels per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -476,13 +516,15 @@ Accept wildcard characters: False ``` ### -PropertiesPerPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, sets the maximum number of properties per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -492,13 +534,15 @@ Accept wildcard characters: False ``` ### -TermSetsPerPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, sets the maximum number of term sets per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -508,13 +552,15 @@ Accept wildcard characters: False ``` ### -TermsPerPartition + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When in partitioned mode, sets the maximum number of terms per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplicationProxy.md index d95abadc1..071153284 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMetadataServiceApplicationProxy.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of a connection to a managed metadata service application. - ## SYNTAX ``` @@ -30,36 +29,35 @@ Use the `Set-SPMetadataServiceApplicationProxy` cmdlet to set the properties of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled -ContentTypePushdownEnabled ``` This example enables content type syndication and enables content type pushdown on an existing connection to a managed metadata service application. - -### -----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled:$false -ContentTypePushdownEnabled:$false ``` This example disables content type syndication and disables content type pushdown on an existing connection to a managed metadata service application. - -### -----------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -DefaultKeywordTaxonomy -DefaultSiteCollectionTaxonomy:$false ``` This example configures an existing connection to a managed metadata service application to be the default location for storing enterprise keywords and prevents it from being the default location for storing column-specific term sets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection to update. The type must be a GUID that represents the identity of the connection to modify, the name of a valid connection to a managed metadata service, or an instance of a valid SPMetadataServiceProxy object. @@ -67,8 +65,7 @@ The type must be a GUID that represents the identity of the connection to modify ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -78,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,13 +118,15 @@ Accept wildcard characters: False ``` ### -ContentTypePushdownEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that existing instances of changed content types in subsites and libraries will be updated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +136,15 @@ Accept wildcard characters: False ``` ### -ContentTypeSyndicationEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +154,9 @@ Accept wildcard characters: False ``` ### -DefaultKeywordTaxonomy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. Do not make more than one connection the default keyword location. @@ -156,8 +164,7 @@ Do not make more than one connection the default keyword location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +174,9 @@ Accept wildcard characters: False ``` ### -DefaultSiteCollectionTaxonomy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata service application. Do not make more than one connection the default location for site collection term sets. @@ -174,8 +184,7 @@ Do not make more than one connection the default location for site collection te ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +194,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new display name of the connection. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,13 +213,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the connection be added to the default proxy group of the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -218,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -225,7 +241,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMicrofeedOptions.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMicrofeedOptions.md index 2d85632d6..32ee28e7d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMicrofeedOptions.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMicrofeedOptions.md @@ -13,8 +13,7 @@ ms.reviewer: # Set-SPMicrofeedOptions ## SYNOPSIS -Sets the feed cache settings. - +Sets the feed cache settings. ## SYNTAX @@ -28,10 +27,9 @@ Set-SPMicrofeedOptions [-AssignmentCollection ] [-AsyncR ## DESCRIPTION Use the Set-SPMicrofeedOptions cmdlet to set the feed cache settings for the current user profile application. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -MaxTags 4 @@ -39,18 +37,19 @@ Set-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -MaxTags 4 This example sets the maximum tags per post and reply to 4 for the specified User Profile Service Application Proxy. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -60,15 +59,16 @@ Accept wildcard characters: False ``` ### -AsyncRefs -Performs reference-posts via async threads. If the value is set to True, each @mention in a thread is handled in its own .NET threadpool async thread. +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Performs reference-posts via async threads. If the value is set to True, each @mention in a thread is handled in its own .NET threadpool async thread. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,13 +78,15 @@ Accept wildcard characters: False ``` ### -MaxCacheMs + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the permissible range of cache loop up time. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,13 +96,15 @@ Accept wildcard characters: False ``` ### -MaxMentions + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number @mentions per post and reply. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,13 +114,15 @@ Accept wildcard characters: False ``` ### -MaxPostLength + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum number of characters in a Microfeed post. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +132,15 @@ Accept wildcard characters: False ``` ### -MaxTags + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number #tags per post and reply. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +150,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -158,13 +168,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMobileMessagingAccount.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMobileMessagingAccount.md index d3d5d0030..1f0488c69 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMobileMessagingAccount.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPMobileMessagingAccount.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the specified mobile messaging account. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPMobileMessagingAccount` cmdlet configures the specified mobile messag For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPMobileMessagingAccount -WebApplication https://sitename -Identity SMS -ServiceName SMSLink -ServiceUrl https://www.adatum.com/Service/MessagingService.asmx-UserId someone@example.com -Password password1 ``` This example changes the SMS mobile account settings of the Web application, https://sitename, to the following values:service name: SMSLink; service URL: https://www.adatum.com/Service/MessagingService.asmx; user ID: someone@example.com; and password: password1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are SMS and MMS. If you do not specify this parameter account, information is returned for both SMS and MMS. @@ -51,7 +51,6 @@ If you do not specify this parameter account, information is returned for both S Type: SPMobileMessagingAccountPipeBind Parameter Sets: (All) Aliases: ServiceType, AccountType -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web application that hosts the managed path to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). @@ -69,8 +71,7 @@ You either must specify WebApplication or must use the HostHeader switch and spe ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,13 +105,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password, if credentials are required for the account. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the SMS service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -ServiceUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the SMS service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -UserId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name, if credentials are required for the account. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPO365LinkSettings.md index f9df8180f..b7aaef2d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPO365LinkSettings.md @@ -26,7 +26,7 @@ Set-SPO365LinkSettings -MySiteHostUrl [-Audiences ] [-Redirec ## DESCRIPTION Use the **Set-SPO365LinkSettings** cmdlet to configure some of Hybrid features (Hybrid site redirection, OneDrive redirection, ODB default to Cloud) without running Hybrid Configuration Wizard. -To run this cmdlet requires farm administrator permission and that the user account has full control access to the User Profile Application service. +To run this cmdlet requires farm administrator permission and that the user account has full control access to the User Profile Application service. ## EXAMPLES @@ -40,13 +40,16 @@ This example sets the mysite host URL to contoso-my.sharepoint.com ## PARAMETERS ### -Audiences + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the user(s) for whom redirection is active. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -55,13 +58,16 @@ Accept wildcard characters: False ``` ### -HybridAppLauncherEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a flag that indicates whether app launcher get data from SharePoint Online (SPO) is allowed ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -70,13 +76,16 @@ Accept wildcard characters: False ``` ### -MySiteHostUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the root URL for the redirected pages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: True Position: Named Default value: None @@ -85,13 +94,16 @@ Accept wildcard characters: False ``` ### -OnedriveDefaultToCloudEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets a flag that indicates whether Local OneDrive is redirected to SPO OneDrive. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Required: False Position: Named Default value: None @@ -99,6 +111,9 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +125,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -125,7 +139,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPOfficeStoreAppsDefaultActivation.md index 7593d0e62..5fb31db8c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPOfficeStoreAppsDefaultActivation.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPOfficeStoreAppsDefaultActivation.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties of apps for Office. - ## SYNTAX ### AppsForOfficeSettingsInSiteSubscription @@ -39,27 +38,27 @@ Use the `Set-SPOfficeStoreAppsDefaultActivation` cmdlet to set app settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 -Enable $true ``` This example enables the apps for Office from the Office Store Office client that uses the subscription id, efca5b88-b3a3-448d-afbc-ef620f4744f1. - ## PARAMETERS ### -Enable + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies whether the apps for Office from the Office Store should be started. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -69,13 +68,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the Site Group to which the settings apply. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the URL, GUID, or name of the web application to which the setting applies. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +118,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPassPhrase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPassPhrase.md index 22ef5297f..01a76c4c8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPassPhrase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPassPhrase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the pass phrase to a new value. - ## SYNTAX ### LocalOnly @@ -43,10 +42,9 @@ So if the Passphrase fails to propagate to all servers, the LocalServerOnly para For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` $passphrase = ConvertTo-SecureString -asPlainText -Force Set-SPPassPhrase -PassPhrase $passphrase -Confirm @@ -54,10 +52,12 @@ Set-SPPassPhrase -PassPhrase $passphrase -Confirm This example queries for a string to use as a passphrase and sets the farm passphrase to a new value. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,14 +98,16 @@ Accept wildcard characters: False ``` ### -LocalServerOnly + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Scopes the Passphrase change to the local server only. If this parameter is not used, the Passphrase change is performed farm-wide. ```yaml Type: SwitchParameter Parameter Sets: LocalOnly -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -131,13 +136,15 @@ Accept wildcard characters: False ``` ### -ConfirmPassPhrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Passphrase is typed a second time to confirm that it matches the first entry. ```yaml Type: SecureString Parameter Sets: AcrossFarm -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -147,13 +154,15 @@ Accept wildcard characters: False ``` ### -PassPhrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new Passphrase value. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointSecureDataValues.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointSecureDataValues.md index 207b1645e..f89979925 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointSecureDataValues.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointSecureDataValues.md @@ -31,14 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1-------------------- +### EXAMPLE 1 ``` Set-SPPerformancePointSecureDataValues -ServiceApplication "PerformancePoint Service Application" -DataSourceUnattendedServiceAccount (get-credential) ``` This example shows how to set the unattended service account by prompting the user for the user name and password. -### --------------------EXAMPLE 2-------------------- +### EXAMPLE 2 ``` Set-SPPerformancePointSecureDataValues -ServiceApplication "PerformancePoint Service Application" -DataSourceUnattendedServiceAccount (New-Object System.Management.Automation.PSCredential "domain\user", (ConvertTo-SecureString "password" -AsPlainText -Force)) ``` @@ -52,6 +52,9 @@ The PSCredential object requires that the password be given as a SecureString ty ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application that is to be configured. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointServiceApplication object. @@ -59,8 +62,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -DataSourceUnattendedServiceAccount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user credentials (user name and password) for the data source of the unattended service account. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +104,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -125,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointServiceApplication.md index 39a19812b..c59db1de8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPerformancePointServiceApplication.md @@ -43,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE---------------------- +### EXAMPLE ``` $sa = Get-SPPerformancePointServiceApplication Set-SPPerformancePointServiceApplication -Identity $sa -DataSourceQueryTimeoutSeconds 5000 @@ -55,6 +55,9 @@ This cmdlet is equivalent to the PerformancePoint Service Settings page on the S ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PerformancePoint Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a PerformancePoint Service application (for example, PerfPointApp1); or an instance of a valid SPPerformancePointMonitoringServiceApplication object. @@ -62,8 +65,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPPerformancePointMonitoringServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +75,9 @@ Accept wildcard characters: False ``` ### -AnalyticQueryCellMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of returned cells in an analytic grid. A valid integer between 1-1,000,000,000. @@ -81,8 +86,7 @@ The default value is 100,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -92,6 +96,9 @@ Accept wildcard characters: False ``` ### -AnalyticQueryLoggingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on verbose logging of query events. The type must be one of the following: True, False. @@ -100,8 +107,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,14 +117,16 @@ Accept wildcard characters: False ``` ### -ApplicationCacheEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether rendered output cache on the application server is on (True) or off (False). The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +136,16 @@ Accept wildcard characters: False ``` ### -ApplicationCacheMinimumHitCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the minimum number of times rendered output must be requested before it is added to cache. The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +155,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool to run the Web service in for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -152,8 +165,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -163,14 +175,16 @@ Accept wildcard characters: False ``` ### -ApplicationProxyCacheEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies rendered output cache on the web front end. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +194,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -191,8 +208,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +218,9 @@ Accept wildcard characters: False ``` ### -CommentsDisabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that users can add comments to scorecard cells. The type must be one of the following: $True, $False. @@ -210,8 +229,7 @@ The default value is $False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -221,6 +239,9 @@ Accept wildcard characters: False ``` ### -CommentsScorecardMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of comments that can be added to a scorecard. The default value is 1000. @@ -229,8 +250,7 @@ The type must be an integer value in the range of 1 to 1,000,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +260,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -247,7 +270,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -257,6 +279,9 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server that contains the PerformancePoint Services database that must be mirrored. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1). @@ -264,8 +289,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +299,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the PerformancePoint Services database that will be created when the service application is provisioned. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation 2010 with Service Pack 1 (SP1). @@ -282,8 +309,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -293,6 +319,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database server where the PerformancePoint Services database will be created. This should be the same server name that is used for the SharePoint content and configuration databases. @@ -303,8 +332,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -314,6 +342,9 @@ Accept wildcard characters: False ``` ### -DatabaseSQLAuthenticationCredential + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether to use Windows authentication or SQL Server authentication when connecting to a PerformancePoint Services database. This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). @@ -321,8 +352,7 @@ This parameter was introduced in SharePoint Server with Service Pack 1 (SP1) and ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -332,6 +362,9 @@ Accept wildcard characters: False ``` ### -DataSourceQueryTimeoutSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in seconds, before a data source query times out. The default value is 300. @@ -340,8 +373,7 @@ The type must be an integer value in the range of 1 to 36,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -351,6 +383,9 @@ Accept wildcard characters: False ``` ### -DecompositionTreeMaximum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items (per level) returned to the decomposition tree visualization. A valid integer value between 1-1,000,000. @@ -359,8 +394,7 @@ The default value is 25. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -370,14 +404,16 @@ Accept wildcard characters: False ``` ### -ElementCacheSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the first class object cache expiration time. The default value is 15. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +423,9 @@ Accept wildcard characters: False ``` ### -FilterRememberUserSelectionsDays + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days that user filter selections are remembered. The default value is 90. @@ -395,8 +434,7 @@ The type must be an integer value in the range of 1 to 10,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -406,6 +444,9 @@ Accept wildcard characters: False ``` ### -FilterTreeMembersMax + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of records to show in filter treeview control. The default value is 500. @@ -414,8 +455,7 @@ An integer value in the range of 1 to 100,000 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -425,6 +465,9 @@ Accept wildcard characters: False ``` ### -IndicatorImageCacheSeconds + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in seconds, that key performance indicator (KPI) icons are cached. The default value is 10. @@ -433,8 +476,7 @@ The type must be an integer value in the range of 1 to 3600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -444,6 +486,9 @@ Accept wildcard characters: False ``` ### -MSMQEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that notifications are sent to Microsoft Message Queuing (MSMQ) on content change. The type must be one of the following: True, False. @@ -452,8 +497,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -463,6 +507,9 @@ Accept wildcard characters: False ``` ### -MSMQName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the queue. The queue name can contain a maximum of 380 characters and cannot contain the following characters: CR (ASCII 13), LF (ASCII 10), backslash (\\), plus sign (+), comma (,), or quotation marks (""). @@ -471,8 +518,7 @@ The type must be a valid MSMQ name; for example, MessageQueue1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -482,6 +528,9 @@ Accept wildcard characters: False ``` ### -SelectMeasureMaximum + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of measures to show in a dashboard Select Measure control. The default value is 1000. @@ -490,8 +539,7 @@ The type must be an integer value in the range of 1 to 1,000,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -501,6 +549,9 @@ Accept wildcard characters: False ``` ### -SessionHistoryHours + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of hours between clearing of expired user navigation history. The default value is 2. @@ -509,8 +560,7 @@ The type must be an integer value in the range of 1 to 48. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -520,13 +570,15 @@ Accept wildcard characters: False ``` ### -SettingsDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the PerformancePoint Service database used for that service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -536,6 +588,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsInitialRows + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the initial number of rows to retrieve for show details. The default value is 1000. @@ -544,8 +599,7 @@ The type must be an integer value in the range of 1 to 100,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -555,6 +609,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsMaxRows + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of rows to retrieve for show details. The type must be an integer value in the range of 1 to 1,000,000. @@ -562,8 +619,7 @@ The type must be an integer value in the range of 1 to 1,000,000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -573,6 +629,9 @@ Accept wildcard characters: False ``` ### -ShowDetailsMaxRowsDisabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns off the ShowDetailsInitialRows setting. If set to true, Analysis Services controls limit. @@ -582,8 +641,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -593,6 +651,9 @@ Accept wildcard characters: False ``` ### -TrustedContentLocationsRestricted + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that only specified locations are trusted. The default setting is false (trust all content locations). @@ -602,8 +663,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -613,6 +673,9 @@ Accept wildcard characters: False ``` ### -TrustedDataSourceLocationsRestricted + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specify to trust only specified data source locations. The default is to trust all data source locations. @@ -622,8 +685,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -633,6 +695,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -640,7 +705,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -650,13 +714,15 @@ Accept wildcard characters: False ``` ### -AnalyticResultCacheMinimumHitCount + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The minimum number of times an analytic report needs to be accessed before caching starts happening. The default value is 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -666,6 +732,9 @@ Accept wildcard characters: False ``` ### -DatabaseUseWindowsAuthentication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When this value is set to true, Performance Point Services disables from using SQL authentication against all data sources. The type must be one of the following: $True, $False. The default value is $False. @@ -673,8 +742,7 @@ The type must be one of the following: $True, $False. The default value is $Fals ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -684,13 +752,15 @@ Accept wildcard characters: False ``` ### -DataSourceUnattendedServiceAccountTargetApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The name of the Secure Store Application that will be used by default to access data sources. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -700,13 +770,15 @@ Accept wildcard characters: False ``` ### -FilterSearchResultsMax + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of items to return on a Dashboard when viewing a filter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -716,6 +788,9 @@ Accept wildcard characters: False ``` ### -UseEffectiveUserName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables the use of the Analysis Services Effective User Name feature. The type must be one of the following: True, False. The default value is False. @@ -723,8 +798,7 @@ The type must be one of the following: True, False. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPowerPointConversionServiceApplication.md index b05e398a8..ad3868751 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPowerPointConversionServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPPowerPointConversionServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures settings for a PowerPoint Conversion Service application. - ## SYNTAX ``` @@ -28,35 +27,34 @@ Set-SPPowerPointConversionServiceApplication [-Identity] Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique name of this PowerPoint Conversion Service application. ```yaml Type: SPPowerPointConversionServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,14 +88,16 @@ Accept wildcard characters: False ``` ### -CacheExpirationPeriodInSeconds + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum time, in seconds, that items remain in the back-end server cache. The default value is 600 seconds (10 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +107,16 @@ Accept wildcard characters: False ``` ### -MaximumConversionsPerWorker + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of presentations that a conversion worker process can convert before recycling. The default value is 5. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +126,16 @@ Accept wildcard characters: False ``` ### -WorkerKeepAliveTimeoutInSeconds + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum time, in seconds, that a conversion worker process can be unresponsive before being terminated. The default value is 120 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +145,9 @@ Accept wildcard characters: False ``` ### -WorkerProcessCount + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of active instances of the conversion worker process on each back-end. This value must be less than the Windows Communication Foundation (WCF) connection limit for this computer. The default value is 3. @@ -146,8 +155,7 @@ The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,14 +165,16 @@ Accept wildcard characters: False ``` ### -WorkerTimeoutInSeconds + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum time, in seconds, that a conversion worker process is given for any single conversion. The default is 300 seconds (5 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplication.md index 6a65a9e82..d51e4ab1b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplication.md @@ -51,10 +51,9 @@ The Set-SPProfileServiceApplication cmdlet sets properties of a User Profile Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true @@ -62,10 +61,12 @@ Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true This example purges objects from the Profile database which are not in scope of the User Profile import. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -73,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -84,6 +84,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -91,8 +94,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +118,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,14 +147,16 @@ Accept wildcard characters: False ``` ### -GetNonImportedObjects + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to inform the users that did not come from the import pipeline and will be marked for deletion. The list of users marked for deletion is displayed to the console window. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,15 +166,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the My Site will be provisioned. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -175,20 +185,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -MySiteManagedPath -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -MySiteManagedPath Specifies the managed path location of personal sites. The type must be a valid URL, in the form https://server_name. @@ -196,8 +196,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,6 +206,9 @@ Accept wildcard characters: False ``` ### -ProfileDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. The type must be a valid PSCredential object. @@ -214,8 +216,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +226,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid PSCredential object. @@ -232,8 +236,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -243,14 +246,16 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,14 +265,16 @@ Accept wildcard characters: False ``` ### -PurgeNonImportedObjects + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to mark the non-imported users in the profile store for deletion and then inform the users that did not come from the import pipeline which will be marked for deletion. The list of users marked for deletion is displayed on the console window ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -277,6 +284,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -295,8 +305,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -306,6 +315,9 @@ Accept wildcard characters: False ``` ### -SocialDBCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. The type must be a valid PSCredential object. @@ -313,8 +325,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -324,14 +335,16 @@ Accept wildcard characters: False ``` ### -SocialDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the failover SQL server for Social database. It is used to build the connection string for the Social database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -341,6 +354,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name for the new User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -350,8 +366,7 @@ The type must be a valid name of a User Profile Service application; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -361,6 +376,9 @@ Accept wildcard characters: False ``` ### -UseOnlyPreferredDomainControllers + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Restricts profile synchronization communication to a specific domain controller. The valid values are $true or $false. @@ -368,8 +386,7 @@ The valid values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -379,6 +396,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -386,7 +406,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -396,13 +415,15 @@ Accept wildcard characters: False ``` ### -ProfileDBFailoverServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationProxy.md index 51d7b9004..dd9ec7b6a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationProxy.md @@ -29,10 +29,9 @@ The `Set-SPProfileServiceApplicationProxy` cmdlet sets properties of a proxy for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE--------------------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPProfileServiceApplicationProxy -Identity $proxy -SiteNamingConflictResolution 2 @@ -40,20 +39,20 @@ Set-SPProfileServiceApplicationProxy -Identity $proxy -SiteNamingConflictResolut This example sets the User Profile Service Application Proxy to use a site naming conflict resolution to use domain names prefixed to usernames. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -102,13 +105,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the User Profile Service application proxy is added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the My Site will be created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -125,8 +133,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed path location of personal sites. The type must be a valid URL, in the form https://server_name. @@ -143,8 +153,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name for the User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -163,8 +175,7 @@ The type must be a name of a valid service application proxy; for example, UserP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +185,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -192,8 +206,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +216,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -210,7 +226,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationSecurity.md index a10a160cf..405e370dc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProfileServiceApplicationSecurity.md @@ -36,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} $security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy @@ -47,7 +47,7 @@ Set-SPProfileServiceApplicationSecurity -Identity $security -ProfileServiceAppli This example revokes the right 'Create Personal Site' from All Authenticated Users. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} $security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy @@ -61,13 +61,15 @@ This example grants the right 'All' to All Authenticated Users. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service Application security object. ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -100,8 +107,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,14 +136,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +155,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the type of object to display. The type is any one of the following values: @@ -155,8 +168,7 @@ The type is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectDatabaseQuota.md index 17547f81a..25724b81e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectDatabaseQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectDatabaseQuota.md @@ -35,27 +35,27 @@ Microsoft internal use only. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` {{ Add example code here }} ``` {{ Add example description here }} - ## PARAMETERS ### -Settings + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: ProjectDatabaseQuotaSettings Parameter Sets: settings -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -65,13 +65,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: SwitchParameter Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -81,13 +83,15 @@ Accept wildcard characters: False ``` ### -MaxDbSize + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +101,15 @@ Accept wildcard characters: False ``` ### -ReadOnlyLimit + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -113,13 +119,15 @@ Accept wildcard characters: False ``` ### -ReadOnlyWarningThreshold + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -129,13 +137,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: Named @@ -145,13 +155,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Microsoft internal use only. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectEventServiceSettings.md index 1ebb28b73..9449223b6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectEventServiceSettings.md @@ -27,17 +27,19 @@ Allows you to change the Microsoft Project Server Events Service 2016 TCP port s ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPProjectEventServiceSettings -NetTcpPort 16100 ``` This example tells the service to listen on port 16100. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -56,13 +57,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: Project Server 2016, Project Server 2019 + TCP port to listen on. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectOdataConfiguration.md index ddd70688a..178f465d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectOdataConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectOdataConfiguration.md @@ -28,56 +28,53 @@ Set-SPProjectOdataConfiguration [-AcceptCountRequests ] [-AcceptProject The `Set-SPProjectOdataConfiguration` cmdlet sets the settings for how the OData service is configured for an instance of Project Web App. It allows the user to configure the settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled and whether verbose errors are enabled. Paging can be specified per entity. -If no paging overrides exist for a given entity, the DefaultMaxPageSize parameter is used. +If no paging overrides exist for a given entity, the DefaultMaxPageSize parameter is used. MaxResultsPerCollection cannot be used in conjunction with paging. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Set-SPProjectOdataConfiguration -ClearEntityPageSizeOverrides ``` This example clears any page size overrides that have been set for any specific entities. - -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Set-SPProjectOdataConfiguration -AcceptProjectionRequests $true ``` This example sets AcceptProjectionRequests to true. - -### ----------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ``` Set-SPProjectOdataConfiguration -DefaultMaxPageSize 50 ``` This example sets the default maximum page size to 50 rows. - -### ----------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ``` Set-SPProjectOdataConfiguration -EntitySetName Assignments -PageSizeOverride 100 ``` This example sets the page size override for the Assignments entity. - ## PARAMETERS ### -AcceptCountRequests + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Sets whether requests with the $count path segment or the $inlinecount query options are accepted. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -87,14 +84,16 @@ Accept wildcard characters: False ``` ### -AcceptProjectionRequests -Sets whether projection requests should be accepted. + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + +Sets whether projection requests should be accepted. Projection requests are made by using the $select query option. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -115,8 +117,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +127,15 @@ Accept wildcard characters: False ``` ### -ClearEntityPageSizeOverrides + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Clears all page-size overrides that had been set for any entities. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -142,14 +145,16 @@ Accept wildcard characters: False ``` ### -DefaultMaxPageSize -Sets the default page size. + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + +Sets the default page size. This is used for any entities that do not have an override set using the PageSizeOverride parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -159,13 +164,15 @@ Accept wildcard characters: False ``` ### -EntitySetName + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the entity name that is used to set a page size override with PageSizeOverride. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -175,14 +182,16 @@ Accept wildcard characters: False ``` ### -MaxResultsPerCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Sets the integer value that indicates the maximum number of results per entity. This parameter cannot be used in conjunction with paging. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -192,13 +201,15 @@ Accept wildcard characters: False ``` ### -PageSizeOverride + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Overrides the page size that is used for a specific entity. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -208,13 +219,15 @@ Accept wildcard characters: False ``` ### -UseVerboseErrors + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Sets the service to use more verbose error messages (for example, stack trace). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPCSSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPCSSettings.md index d8dec2a5c..99e4b7bb2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPCSSettings.md @@ -32,27 +32,27 @@ The settings have maximum and minimum values that are enforced by Project Server For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPProjectPCSSettings -sa "Project Service Application" -MaximumSessionsPerUser 500 ``` This example sets 500 as the maximum allowed Project Calculation Engine sessions that a user can open on the "Project Service Application" service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Project Server service application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -62,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +86,15 @@ Accept wildcard characters: False ``` ### -CachePersistence + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum length of time before the Project Calculation Engine can begin to remove temporary cache files of projects opened on the Project Server service application. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +104,15 @@ Accept wildcard characters: False ``` ### -EditingSessionTimeout + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum length of time that a user can be idle in a Project Calculation Engine session before a timeout occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +122,15 @@ Accept wildcard characters: False ``` ### -MaximumIdleWorkersCount + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum number of idle Project Calculation Engine sessions available at a given time. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +140,15 @@ Accept wildcard characters: False ``` ### -MaximumProjectSize + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum size of a project that can be opened by the Project Calculation Engine. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -148,13 +158,15 @@ Accept wildcard characters: False ``` ### -MaximumSessionsPerUser + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum number of sessions that a user is allowed to open. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +176,15 @@ Accept wildcard characters: False ``` ### -MaximumWorkersCount + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum number of Project Calculation Engine sessions that can be created. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +194,15 @@ Accept wildcard characters: False ``` ### -MinimumMemoryRequired + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The minimum memory required before launching a new Project Calculation Engine session. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -196,13 +212,15 @@ Accept wildcard characters: False ``` ### -RequestTimeLimits + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The maximum allowable time for a request to the Project Calculation Engine to complete before the Project Calculation Engine session is terminated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -212,13 +230,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: Project Server 2016, Project Server 2019 + The TCP port to use with the PCS service. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPermissionMode.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPermissionMode.md index f404723ca..01f583dec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPermissionMode.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectPermissionMode.md @@ -32,25 +32,26 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ``` Set-SPPRojectPermissionMode -Url https://AppServer/pwa -Mode ProjectServer ``` This example shows the syntax for transitioning a server into Project Server permission mode. - -### --------------EXAMPLE 2------------------- +### EXAMPLE 2 ``` Set-SPPRojectPermissionMode -Url https://AppServer/pwa -Mode SharePoint ``` This example shows the syntax for transitioning a server into SharePoint permission mode. - ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance for which the permission mode is to be changed. The type must be a valid URL, in the form https://\/\. @@ -58,8 +59,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +69,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the mode into which the instance should be changed. The type must be a valid permission mode, in the form SharePoint or ProjectServer. @@ -76,8 +79,7 @@ The type must be a valid permission mode, in the form SharePoint or ProjectServe ```yaml Type: PermissionMode Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectQueueSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectQueueSettings.md index 52cb8f842..952451f51 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectQueueSettings.md @@ -31,20 +31,21 @@ Sets the value of one or multiple Project Server Queue settings for a specific P For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPProjectQueueSettings -ServiceApplication "Project Service Application" -MaxDegreeOfConcurrency 6 ``` This example sets a maximum of 6 for the number of jobs that can be processed at one time by the specified service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -53,7 +54,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: Named @@ -63,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -85,6 +87,9 @@ Accept wildcard characters: False ``` ### -CleanupNonSuccessAgeLimit + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + This setting determines the age threshold at which any job in a completed, non-successful state (example: Failed But Not Blocking Correlation) can be purged when the Queue Cleanup job runs. The age of each job is determined by the completed date and time. For example, if a job was cancelled at 2/1/2007 10:41 p.m. @@ -96,8 +101,7 @@ Minimum: 1;Maximum: 100000;Default: 168 (7 days) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +111,9 @@ Accept wildcard characters: False ``` ### -CleanupSuccessAgeLimit + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + This setting determines the age threshold at which successful jobs can be purged when the Queue Cleanup job runs. The age of each job is determined by the completed date and time. For example, if a job succeeded at 2/1/2007 10:41 p.m. @@ -118,8 +125,7 @@ Minimum: 1;Maximum: 100000;Default: 24 (1 day) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +135,9 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Maximum number of Queue connections allowed to be pending dispatch on the server. Default: 10 @@ -136,8 +145,7 @@ Default: 10 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +155,9 @@ Accept wildcard characters: False ``` ### -MaxDegreeOfConcurrency + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Queue is multi-threaded, which enables multiple jobs to be processed at the same time. This setting limits the degree of concurrency of the queue. Note that this setting is per Project Server service application. @@ -156,8 +167,7 @@ Minimum: 1;Maximum: 10;Default: 4 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +177,9 @@ Accept wildcard characters: False ``` ### -MsgRetryInterval + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will wait for the Retry Interval to elapse and retry the job. Minimum: 0 (immediately retry);Maximum: 300000 (5 minutes);Default: 1000 (1 second) @@ -174,8 +187,7 @@ Minimum: 0 (immediately retry);Maximum: 300000 (5 minutes);Default: 1000 (1 seco ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +197,9 @@ Accept wildcard characters: False ``` ### -MsgRetryLimit + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will retry the job. The number of retries is bound by the Retry Limit. @@ -193,8 +208,7 @@ Minimum: 0 (no retries);Maximum: 100;Default: 5 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +218,9 @@ Accept wildcard characters: False ``` ### -PeriodicTasksInterval + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + There are a number of bookkeeping tasks executed by the Queue System. Some examples are awakening jobs in 'Sleeping' state, updating the heartbeat timestamp, checking whether Queue Cleanup needs to be executed and so on. This setting controls the time interval at which these tasks run. @@ -213,8 +230,7 @@ Minimum: 500 (1/2 second);Maximum: 300000 (5 minutes);Default: 10000 (10 second) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +240,9 @@ Accept wildcard characters: False ``` ### -QueueTimeout + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Queue System has a failover recovery feature. If the farm contains multiple servers running the Project Server Application Service and the Queue Service fails on one server, jobs are automatically redistributed to other servers on which the Queue Service is online. A Queue Service is considered to have timed out if it cannot be accessed from the Queue health timer job for more than the 'Queue Timeout' interval. @@ -233,8 +252,7 @@ Minimum: 5 minutes;Maximum: 60 minutes;Default: 15 minutes ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +262,9 @@ Accept wildcard characters: False ``` ### -SqlCommandTimeout + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The Queue makes SQL calls for retrieving and executing jobs. This setting controls the timeout value for all such calls. If any job fails due to a SQL Timeout error, administrators can increase this setting and retry the job. @@ -253,8 +274,7 @@ Minimum: 30 seconds;Maximum: 86400 (1 day);Default: 1800 (30 minutes) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +284,9 @@ Accept wildcard characters: False ``` ### -SqlRetryInterval + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will wait for the SQL Retry Interval to elapse and retry the query. Minimum: 0 (immediately retry);Maximum: 60000 (1 minute);Default: 1000 (1 second) @@ -271,8 +294,7 @@ Minimum: 0 (immediately retry);Maximum: 60000 (1 minute);Default: 1000 (1 second ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -282,6 +304,9 @@ Accept wildcard characters: False ``` ### -SqlRetryLimit + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will retry the query after the SQL Retry Interval has elapsed. The number of retries is bound by the SQL Retry Limit. @@ -290,8 +315,7 @@ Minimum: 0 (no retries)Maximum: 100Default: 5 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -301,13 +325,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: Project Server 2016, Project Server 2019 + Sets the TCP port the Project Queue service uses. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectServiceApplication.md index c405b3bd4..294390f6d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectServiceApplication.md @@ -30,17 +30,19 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set- SPProjectServiceApplication -Identity PSIServiceApp -ApplicationPool newapppool RegisterTimerJob ``` This example updates the application pool and re-registers the timer job for a Project Server Service application. - ## PARAMETERS ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the Project Server Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the existing IIS application pool to run the web service in for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -66,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSync.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSync.md index 9ff05b085..79f33851c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSync.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSync.md @@ -32,24 +32,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPProjectUserSync https://localhost/pwa EnablePWA ``` In this example, WSS User sync is enabled for the Project Web App site at https://localhost/pwa. - ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance to set the Project User Sync settings. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Disabled completely disables WSS User Sync; EnablePWA enables WSS User sync for the Project Web App site; EnableEntProj enables WSS User sync for all SharePoint sites connected to Enterprise Projects; EnableSPProj enables WSS User sync for all SharePoint sites connected to SharePoint Projects; EnableAll enables WSS User sync for the Project Web App site and all connected SharePoint sites. ```yaml Type: UserSyncParameterValues[] Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 3 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncDisabledSyncThreshold.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncDisabledSyncThreshold.md index ec980f426..af5021113 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncDisabledSyncThreshold.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncDisabledSyncThreshold.md @@ -35,24 +35,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPProjectUserSyncDisabledSyncThreshold -URL http//contoso-AppSrv/PWA -Threshold 400 ``` This example sets the sync disable threshold for the Project Web App instance at http//contoso-AppSrv/PWA to 400. - ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 3 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncFullSyncThreshold.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncFullSyncThreshold.md index 698547ce9..f00de6d5a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncFullSyncThreshold.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncFullSyncThreshold.md @@ -35,24 +35,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPProjectUserSyncFullSyncThreshold -URL https://contoso-AppSrv/ -Threshold 800 ``` This example sets the full user sync threshold for the Project Web App instance at https://contoso-AppSrv/PWA to 800. - ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 3 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncOffPeakSyncThreshold.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncOffPeakSyncThreshold.md index aa138d296..4b44af330 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncOffPeakSyncThreshold.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPProjectUserSyncOffPeakSyncThreshold.md @@ -35,24 +35,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPProjectUserSyncOffPeakSyncThreshold -URL https://contoso/PWA -Threshold 900000 ``` This example sets the sync off-peak threshold for the Project Web App instance at https://contoso-AppSrv/PWA to 900000. - ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 2 @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 3 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRequestManagementSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRequestManagementSettings.md index 700dbe5ae..a0b4712a4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRequestManagementSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRequestManagementSettings.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets Request Manager properties. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $wa = Get-SPWebApplication https://webAppUrl $req = $wa | Get-SPRequestManagementSettings @@ -43,13 +42,15 @@ This example disables throttling on the specified Web Application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Request Manager object for which settings will be applied. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -RoutingEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether routing is enabled or disabled for the Request Manager object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -RoutingScheme + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the routing scheme. The value is one of the following: @@ -104,8 +112,7 @@ The value is one of the following: ```yaml Type: SPRoutingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -ThrottlingEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether throttling is enabled or disabled for the Request Manager object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachineInfo.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachineInfo.md index fb9a8b2c3..f662371f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachineInfo.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets routing target properties. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $wa = Get-SPWebApplication -Identity https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -45,13 +44,15 @@ This example sets the "Availability" routing target property to Unavailable for ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingMachineInfoPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether or not the specified computer will be available for routing. The valid values are: @@ -93,8 +99,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -ClearOutgoingPort + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Clears the outgoing port if it is set. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +127,15 @@ Accept wildcard characters: False ``` ### -OutgoingPort -Specifies the port used by Request Manager to make an outgoing connection. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the port used by Request Manager to make an outgoing connection. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +145,9 @@ Accept wildcard characters: False ``` ### -OutgoingScheme + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines the schema of outgoing connections. The valid values are: @@ -148,8 +159,7 @@ The valid values are: ```yaml Type: SPRoutingOutgoingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,14 +169,16 @@ Accept wildcard characters: False ``` ### -StaticWeight + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the static weight of a computer routing is used by Request Manager. If the static weight is higher, more requests will be routed to the computer. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachinePool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachinePool.md index d086070a0..a81981d1a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingMachinePool.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a machine pool. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $wa = Get-SPWebApplication -Identity https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -44,13 +43,15 @@ This example sets the routing machine pool on the specified Web Application. Usi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -MachineTargets + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the routing targets collection that the machine pool will contain. ```yaml Type: SPRoutingRuleTargetPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingRule.md index f1b807fe5..da262d378 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPRoutingRule.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes properties of an existing routing rule. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the `Set-SPRoutingRule` cmdlet to change properties of an existing routing r For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $wa = Get-SPWebApplication https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -47,17 +45,18 @@ Set-SPRoutingRule -Identity $rule -Criteria $criteriaNew This example sets a routing rule for the specified identity by using the $rule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +76,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -ExecutionGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the group in which the rule will be placed. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +140,15 @@ Accept wildcard characters: False ``` ### -MachinePool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the pool of machines to which a request will be routed if the changed rule is matched. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataRange.md index 50bf51e49..c24769c98 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataRange.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Extends the range of a specified scale-out database. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the `Set-SPScaleOutDatabaseDataRange` cmdlet to extend the range of a specif For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -45,17 +43,18 @@ Set-SPScaleOutDatabaseDataRange -Database $database -Range $state.Range -NewRang This example extends the data range end point of the first database in the specified service application up to the maximum range point. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to which to extend the data range. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to set the start or the end point of the data range with the specified value in the NewRangePoint parameter. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -NewRangePoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new start or end point of the database. The maximum value is NULL. @@ -143,8 +153,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -161,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataSubRange.md index c17b34d0c..fdd12a53a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataSubRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPScaleOutDatabaseDataSubRange.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a subrange for a specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -40,10 +39,9 @@ A subrange is a subset of a range of data. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` C:\PS>$databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -56,17 +54,18 @@ Set-SPScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubR This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - ## PARAMETERS ### -ConnectionString + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the connection string for the scale-out database to create the new data sub-range. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,13 +75,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the scale-out database to create the data subrange. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -92,13 +93,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to create the data subrange on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -108,13 +111,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expected current range of the scale-out database prior to this operation. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -SubRangeMode + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the mode of the data subrange to be created. The data subrange mode values are the following: @@ -135,8 +143,7 @@ The data subrange mode values are the following: ```yaml Type: SPScaleOutDatabaseSubRangeMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -157,8 +167,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -175,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -185,14 +196,16 @@ Accept wildcard characters: False ``` ### -IgnoreSubRangePointOnBoundary + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the database is hosted on SQL Azure. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -SubRangePoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the start or end point of the data subrange to be created as defined by the following criteria: --The start point if the data sub-range is created on the upper side of the data range. @@ -228,8 +246,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -239,6 +256,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -246,7 +266,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreApplication.md index a62cd1394..8d66d496c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a Secure Store application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ The `Set-SPSecureStoreApplication` cmdlet sets properties of a Secure Store appl For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$targetApp.FriendlyName = "Updated Contoso Target App" @@ -42,17 +40,18 @@ Set-SPSecureStoreApplication -Identity $application -TargetApplication $targetAp This example sets a new display name Updated Contoso Target App for the target application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Store application to update. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -Administrator + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the administrator of the Secure Store application. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,13 +122,15 @@ Accept wildcard characters: False ``` ### -CredentialsOwnerGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the claims object for the groups that own the group credentials. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +140,16 @@ Accept wildcard characters: False ``` ### -Fields + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the field information for the application. The default fields are username and password. ```yaml Type: TargetApplicationField[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -TargetApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the target application. ```yaml Type: TargetApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +177,15 @@ Accept wildcard characters: False ``` ### -TicketRedeemer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the ticket redeemer claim value. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +195,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -189,7 +205,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreDefaultProvider.md index 6c39bba8f..5618f011e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreDefaultProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreDefaultProvider.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the secure store provider. - ## SYNTAX ``` @@ -31,10 +30,9 @@ You can then set the secure store provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>[Reflection.Assembly]::LoadFrom("C:\ContosoFolder\contosoSecureStore.dll") @@ -45,17 +43,18 @@ Set-SPSecureStoreDefaultProvider -Type $type This example sets the custom implemented secure store provider. - ## PARAMETERS ### -Type + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The type must be a secure store provider type enclosed in square brackets; for example, \[Reflection.Assembly\]. ```yaml Type: Type Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreServiceApplication.md index 69176215a..6ac5424aa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecureStoreServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a Secure Store Service application in the farm. - ## SYNTAX ``` @@ -31,27 +30,27 @@ The `Set-SPSecureStoreServiceApplication` cmdlet sets properties of a Secure Sto For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Set-SPSecureStoreServiceApplication -Identity $contosoServApp -AuditlogMaxSize 40 ``` This example sets the maximum size of the audit log to 40 days for the given service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to update. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS application pool to run the Web service in for the new service application. ```yaml Type: SPIisWebServiceApplicationPool Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -AuditingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on auditing for the Secure Store Service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -AuditlogMaxSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days to retain the audit log. The type must be a valid integer. @@ -122,8 +130,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +177,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -182,14 +195,16 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +232,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -232,13 +251,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -248,13 +269,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Secure Store Service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +287,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -271,7 +297,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecurityTokenServiceConfig.md index 974e4d962..de6f873ff 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecurityTokenServiceConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSecurityTokenServiceConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the settings of the SharePoint security token service (STS) identity provider. - ## SYNTAX ### QueueSigningCertificateReference @@ -85,18 +84,16 @@ To create a certificate which can be used in this cmdlet specify the X509KeyStor For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SPSecurityTokenServiceConfig -SigningCertificateThumbprint "2796BAE63F1801E277261BA0D77770028F20EEE4" ``` This example updates the signing certificate of the SharePoint security token service (STS) identity provider with a certificate that has been deployed in the certificate store. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` $stsCert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 "c:\sts.pfx","a",20 Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert @@ -104,17 +101,18 @@ Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert This example imports the signing certificate for the SharePoint STS identity provider. - ## PARAMETERS ### -QueueSigningCertificateThumbprint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the certificate with the provided thumbprint as the queued signing certificate. ```yaml Type: String -Parameter Sets: QueueSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: QueueSigningCertificateReference, SigningCertificateReference +Aliases: Required: True Position: Named @@ -123,27 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -RevokeSigningCertificateThumbprint -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -RevokeSigningCertificateThumbprint Revoke the signing certificate with the provided thumbprint. ```yaml Type: String Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -153,6 +140,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateThumbprint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the thumbrpint of the signing certificate. The type must be a valid identity of a signing certificate; for example 2796BAE63F1801E277261BA0D77770028F20EEE4. @@ -160,8 +150,7 @@ The type must be a valid identity of a signing certificate; for example 2796BAE6 ```yaml Type: String Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -171,6 +160,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -182,8 +174,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -193,6 +184,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -200,7 +194,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -210,6 +203,9 @@ Accept wildcard characters: False ``` ### -FormsTokenLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration time, in minutes, for tokens issued to ASP.NET Membership Provider and Role providers. The default value is 1380. @@ -218,8 +214,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +224,9 @@ Accept wildcard characters: False ``` ### -ImportSigningCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -236,8 +234,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateImport -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +244,9 @@ Accept wildcard characters: False ``` ### -MaxLogonTokenCacheItems + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of entries for the in-memory logon token cache. The default value is 250 entries. @@ -255,8 +255,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -266,6 +265,9 @@ Accept wildcard characters: False ``` ### -MaxServiceTokenCacheItems + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of entries for the in-memory service token cache. The default value is 250 entries. @@ -274,8 +276,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -285,13 +286,15 @@ Accept wildcard characters: False ``` ### -QueueSigningCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the provided certificate as the queued signing certificate. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateQueue -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -301,13 +304,15 @@ Accept wildcard characters: False ``` ### -QueueSigningCertificateStoreName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The store to search in when looking up a certificate to be set as the queued signing certificate by its thumbprint. Required if QueueSigningCertificateThumbprint was specified. ```yaml Type: String Parameter Sets: QueueSigningCertificateReference, SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -317,13 +322,15 @@ Accept wildcard characters: False ``` ### -RevokeSigningCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Revokes the signing certificate that matches the provided certificate. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateRevoke -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -333,13 +340,15 @@ Accept wildcard characters: False ``` ### -RevokeSigningCertificateStoreName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The store to search when looking up a certificate to be revoked by its thumbprint. Required if the QueueSigningCertificateThumbprint was specified. ```yaml Type: String Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -349,6 +358,9 @@ Accept wildcard characters: False ``` ### -ServiceTokenCacheExpirationWindow + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the interval, in minutes, for automatically renewing the token in the cache. The default value is 2 minutes. @@ -357,8 +369,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -368,6 +379,9 @@ Accept wildcard characters: False ``` ### -ServiceTokenLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration time, in minutes, for the security token service cache. The default value is 15 minutes. @@ -376,8 +390,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +400,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateStoreName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the certificate store where the signing certificate resides. The identity store for an identity provider can be a SQL database table, an Active Directory Domain Services (AD DS), or Active Directory Lightweight Directory Service (AD LDS). @@ -395,8 +411,7 @@ The type must be a valid identity of a signing certificate store; for example Id ```yaml Type: String Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -406,6 +421,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -413,7 +431,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -423,6 +440,9 @@ Accept wildcard characters: False ``` ### -WindowsTokenLifetime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration time, in minutes, for tokens issued to Windows users. The default value is 1380 minutes. @@ -431,8 +451,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServer.md index bf5df1248..442558f6e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes the role of the server. - ## SYNTAX ``` @@ -26,29 +25,29 @@ Set-SPServer [-Identity] [-AssignmentCollection Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the server in the farm. ```yaml Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 0 @@ -74,7 +75,10 @@ Accept wildcard characters: False ``` ### -Role -Specifies the name of the server role you want to change. + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Specifies the name of the server role you want to change. The valid values are: @@ -87,13 +91,11 @@ The valid values are: * ApplicationWithSearch * WebFrontEndWithDistributedCache - ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,14 +105,16 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Sets the status of the server in the farm. ```yaml Type: SPObjectStatus Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Online, Disabled, Offline, Unprovisioning, Provisioning, Upgrading, Patching -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataRange.md index 1b7b7b52d..091a81343 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataRange.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Extends the range of a specified scale-out database. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Set-SPServerScaleOutDatabaseDataRange -Database -IsUpperSub ## DESCRIPTION Use the Set-SPServerScaleOutDatabaseDataRange cmdlet to extend the range of a specified scale-out database in a specified direction. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -40,18 +38,18 @@ Set-SPServerScaleOutDatabaseDataRange -Database $database -Range $state.Range -N This example extends the data range end point of the first database in the specified service application up to the maximum range point. - ## PARAMETERS ### -Database -Specifies the scale-out database to which to extend the data range. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the scale-out database to which to extend the data range. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -61,14 +59,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange -Specifies whether to set the start point or the end point of the data range with the specified value in the NewRangePoint parameter. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether to set the start point or the end point of the data range with the specified value in the NewRangePoint parameter. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,14 +77,15 @@ Accept wildcard characters: False ``` ### -Range -Specifies the expected data range of the scale-out database. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -95,16 +95,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -131,14 +133,16 @@ Accept wildcard characters: False ``` ### -NewRangePoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new start point or end point of the database. The maximum value is NULL. ``yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -148,15 +152,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataSubRange.md index 1b3aa735f..2b0a1b56c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataSubRange.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServerScaleOutDatabaseDataSubRange.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a subrange for a specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -37,10 +36,9 @@ Set-SPServerScaleOutDatabaseDataSubRange -Database -IsUpper ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets] (https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -51,18 +49,18 @@ Set-SPServerScaleOutDatabaseDataSubRange -Database $database -Range $state.Range This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - ## PARAMETERS ### -ConnectionString -Specifies the connection string for the scale-out database to create the new data sub-range. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the connection string for the scale-out database to create the new data sub-range. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -72,14 +70,15 @@ Accept wildcard characters: False ``` ### -Database -Specifies the scale-out database to create the data subrange. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the scale-out database to create the data subrange. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -89,14 +88,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange -Specifies whether to create the data subrange on the upper or lower side of the data range. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether to create the data subrange on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -106,14 +106,15 @@ Accept wildcard characters: False ``` ### -Range -Specifies the expected current range of the scale-out database prior to this operation. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the expected current range of the scale-out database prior to this operation. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -124,14 +125,14 @@ Accept wildcard characters: False ### -SubRangeMode +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 ```yaml Type: SPScaleOutDatabaseSubRangeMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -141,16 +142,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,14 +162,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -177,14 +180,15 @@ Accept wildcard characters: False ``` ### -IgnoreSubRangePointOnBoundary -Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,14 +198,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase -Specifies whether the database is hosted on SQL Azure. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether the database is hosted on SQL Azure. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -211,7 +216,10 @@ Accept wildcard characters: False ``` ### -SubRangePoint -Specifies the start or end point of the data subrange to be created as defined by the following criteria: + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the start or end point of the data subrange to be created as defined by the following criteria: --The start point if the data sub-range is created on the upper side of the data range. --The end point if the data sub-range is created on the lower side of the data range. @@ -221,8 +229,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -232,15 +239,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplication.md index f37f5ec56..fe81f2334 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a service application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Use the `Set-SPServiceApplication` cmdlet to set various properties of a service For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE---------------- +### EXAMPLE ``` C:\PS>$serviceapp = Get-SPServiceApplication "My Service App" @@ -43,10 +41,12 @@ Set-SPServiceApplication $serviceapp -DefaultEndpoint https This example sets the default endpoint of the service application to be https. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,13 +64,15 @@ Accept wildcard characters: False ``` ### -DefaultEndpoint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the address of the default endpoint of the service application. ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +96,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -IisWebServiceApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or identity of the application pool used by the service application. The IisWebServiceApplicationPool parameter only applies to Web Service applications. @@ -110,8 +116,7 @@ The IisWebServiceApplicationPool parameter only applies to Web Service applicati ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If the ServiceApplicationProxyGroup parameter is not specified, the farm's default proxy group is used. @@ -128,8 +136,7 @@ If the ServiceApplicationProxyGroup parameter is not specified, the farm's defau ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationEndpoint.md index 616c85dab..0f7e64c85 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationEndpoint.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationEndpoint.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the host of an endpoint for a service application. - ## SYNTAX ### HostName @@ -40,20 +39,21 @@ Use the second parameter set to reset the host of the service endpoint to use th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------- +### EXAMPLE ``` Set-SPServiceApplicationEndpoint -Identity "ServiceApp1" -HostName http://sitename -ResetHostName $true ``` This example associates the SPServiceEndpoint object with the specified identity and resets the hostname. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service endpoint to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. @@ -61,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -HostName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the default host of the service endpoint. The type must be a valid full load balanced URL, in the form http://server_name. @@ -79,8 +81,7 @@ The type must be a valid full load balanced URL, in the form http://server_name. ```yaml Type: String Parameter Sets: HostName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,13 +91,15 @@ Accept wildcard characters: False ``` ### -ResetHostName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the current host of the service endpoint and uses the default host. ```yaml Type: SwitchParameter Parameter Sets: ResetHostName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -117,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +162,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationPool.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationPool.md index 1aec8ea22..e9c29a243 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationPool.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes the account used for the Identity of the specified application pool. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Set-SPServiceApplicationPool` cmdlet changes the account used for the Ident For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPServiceApplicationPool TestServiceWebApplicationPool -Account testdomain\testuser1 ``` @@ -43,17 +41,18 @@ For the Account parameter, the name of a managed account in the farm can be give Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web service application pool to configure. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,13 +62,15 @@ Accept wildcard characters: False ``` ### -Account + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials that will be the new Identity of the application pool. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 2 @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationSecurity.md index 529047a1a..fe7453c6c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceApplicationSecurity.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the SPObjectSecurity object for a service application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Use this cmdlet with the `Grant-SPObjectSecurity` and `Get-SPServiceApplicationS For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication -Identity $security = Get-SPServiceApplicationSecurity $sa -Admin @@ -45,10 +43,12 @@ Set-SPServiceApplicationSecurity $sa -Admin $security This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service application that contains the SPObjectSecurity object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object. @@ -56,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -67,13 +66,15 @@ Accept wildcard characters: False ``` ### -ObjectSecurity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPObjectSecurity object to update. ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -Admin + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Updates the access control list (ACL) that contains the administrators list of the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceHostConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceHostConfig.md index 7a502d862..226918e52 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceHostConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPServiceHostConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures one or more common settings for all Web services. - ## SYNTAX ### SslCertificateReference @@ -41,27 +40,27 @@ The `Set- SPServiceHostConfig` cmdlet configures one or more common settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPServiceHostConfig -Port 12345 ``` This example sets the HTTP port for the Web services. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity of the Web service application to configure. ```yaml Type: SPIisWebServiceSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -71,13 +70,15 @@ Accept wildcard characters: False ``` ### -SslCertificateThumbprint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the thumbprint of the SSL certificate to retrieve for secure protocols. ```yaml Type: String Parameter Sets: SslCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +102,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -126,13 +131,15 @@ Accept wildcard characters: False ``` ### -HttpPort + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new port for the Web service. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Port -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -142,13 +149,15 @@ Accept wildcard characters: False ``` ### -HttpsPort + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new secure port for the Web service. ```yaml Type: Int32 Parameter Sets: (All) Aliases: SecurePort -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,13 +167,15 @@ Accept wildcard characters: False ``` ### -ImportSslCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SSL Certificate to use for secure protocols. ```yaml Type: X509Certificate2 Parameter Sets: SslCertificateImport -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,13 +185,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the TCP port for the Web service. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -190,13 +203,15 @@ Accept wildcard characters: False ``` ### -NoWait + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + For more information, see TechNet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +221,15 @@ Accept wildcard characters: False ``` ### -SslCertificateStoreName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the thumbprint of the SSL certificate to retrieve for secure protocols. ```yaml Type: String Parameter Sets: SslCertificateReference -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -229,7 +249,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSessionStateService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSessionStateService.md index e4d0925cb..d243df54b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSessionStateService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSessionStateService.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the credentials that are used to communicate with the state service database. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Set-SPSessionStateService` cmdlet updates the credentials that are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPSessionStateService -SessionTimeout 120 ``` This example changes the ASP.NET session state time-out to 2 hours. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -71,7 +73,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database credentials for SQL Authentication that are used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -89,8 +93,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in minutes that an ASP.NET session will remain active with no user activity. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSite.md index 861d81568..98d233609 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSite.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the specified sites. - ## SYNTAX ### SiteSubscription @@ -46,28 +45,28 @@ The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and W For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Get-SPSite https://sitename/sites/teams/* | Set-SPSite -SecondaryOwner "DOMAIN\Jdoe" ``` This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Set-SPSite -identity "https://sitename" -MaxSize 4000000 -WarningSize 2000000 ``` This example configures the Quota settings for the site collection https://sitename. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to configure, or refers to an SPSite object that contains sites to configure. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. @@ -75,8 +74,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,6 +84,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site type. Valid values are None or TentantAdministration. @@ -93,8 +94,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -115,8 +118,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -133,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -143,14 +147,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter. ```yaml Type: SwitchParameter Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +166,9 @@ Accept wildcard characters: False ``` ### -LockState + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the lock state of this site collection. The valid lock states are @@ -176,8 +185,7 @@ Users who attempt to access the site receive an access-denied message. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +195,9 @@ Accept wildcard characters: False ``` ### -MaxSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum storage size for the site collection in bytes. The integer value must be larger than the WarningSize value. @@ -195,8 +206,7 @@ You cannot use this parameter if the site collection is using a quota template. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +216,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the alias name of the site collection administrator. The type must be a valid e-mail alias, in the form domain\username. @@ -213,8 +226,7 @@ The type must be a valid e-mail alias, in the form domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +236,9 @@ Accept wildcard characters: False ``` ### -QuotaTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new quota template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef or a string @@ -231,8 +246,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef ```yaml Type: SPQuotaTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -242,6 +256,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the alias of the secondary site collection administrator. The type must be a valid e-mail alias, in the form domain\username. @@ -249,8 +266,7 @@ The type must be a valid e-mail alias, in the form domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +276,15 @@ Accept wildcard characters: False ``` ### -SharingType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether external access a site collection should be disabled, limited to external users only, or enabled for external users and anonymous guests. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +294,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +312,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. @@ -299,8 +322,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -310,13 +332,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL of the new site. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -326,13 +350,15 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets an organization unit to which to scope user accounts. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,6 +368,9 @@ Accept wildcard characters: False ``` ### -WarningSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the storage warning level for the site collection in bytes. The integer value must be between 0 and the MaxSize value. @@ -350,8 +379,7 @@ You cannot use this parameter if the site collection is using a quota template. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -361,6 +389,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -368,7 +399,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteAdministration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteAdministration.md index 700620fa6..171bc9aa8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteAdministration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteAdministration.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Allows farm administrators to configure any site collection. - ## SYNTAX ### SiteSubscription @@ -44,20 +43,21 @@ Any parameter that is not provided is not changed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPSiteAdministration https://sitename -OwnerAlias "DOMAIN\NewOwner" ``` This example allows farm administrators to change the ownership of a site collection to which they do not have access. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL (full or partial) or GUID of the site collection. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-456-987fg. @@ -65,8 +65,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPSiteAdministrationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -76,6 +75,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site type. Valid values are None or TentantAdministration. @@ -83,8 +85,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +109,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -133,14 +138,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter. ```yaml Type: SwitchParameter Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -LockState + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the lock state for the given site collection. The type must be any of the following values: @@ -162,8 +172,7 @@ The type must be any of the following values: ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,18 +182,19 @@ Accept wildcard characters: False ``` ### -MaxSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the maximum storage size of the site collection. The type must be a valid number greater than or equal to 0. Set to 0 for unlimited. - ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,6 +204,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the owner of this site collection. The type must be a valid user alias. @@ -201,8 +214,7 @@ The type must be a valid user alias. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +224,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the secondary owner of this site collection. The type must be a valid user alias. @@ -219,8 +234,7 @@ The type must be a valid user alias. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +244,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +262,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web template for the top-level Web site of this site collection. This can only be given if the template has not already been configured. @@ -254,8 +273,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef, ```yaml Type: SPWebTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -265,6 +283,9 @@ Accept wildcard characters: False ``` ### -WarningSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection warning size limit. The type must be a valid number greater than or equal to 0. @@ -273,8 +294,7 @@ Set to 0 for unlimited. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -284,6 +304,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -291,7 +314,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionConfig.md index 36123aa23..dd4d45275 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the configuration properties of a site subscription. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPSiteSubscriptionConfig` cmdlet sets the configuration properties of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPSiteSubscriptionConfig https://contoso.com -FeaturePack 12345678-90ab-cdef-1234-567890abcdef ``` This example sets the Feature set of the entire site subscription that contains https://contoso.com with a Feature pack GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription configuration to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the output object can be passed through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the site user account directory path to a specific organizational unit (OU) that is in the same domain as the site subscription. The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGCorp,DC=local. @@ -123,8 +131,7 @@ The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -FeaturePack + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill FeaturePack Description}} ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionEdiscoveryHub.md index f29e24d70..c00a32474 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionEdiscoveryHub.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionEdiscoveryHub.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties for the eDiscovery hub of a site subscription. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Set-SPSiteSubscriptionEdiscoveryHub` cmdlet sets global properties and sett For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE-------------------- +### EXAMPLE ``` Set-SPSiteSubscriptionEdiscoverySearchScope -Site https://contoso.com/sites/sitecollection1 -SearchScope 1 ``` @@ -39,17 +37,18 @@ Set-SPSiteSubscriptionEdiscoverySearchScope -Site https://contoso.com/sites/site This example enables the search scope for the entire site subscription. A value of zero (0) disables the search scope across the entire site subscription. - ## PARAMETERS ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for the Ediscovery hub. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,14 +101,16 @@ Accept wildcard characters: False ``` ### -SearchScope + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name for the search scope. The default value is All Sites. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionIRMConfig.md index 7f0f29cca..73dd6994f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionIRMConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionIRMConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the Identity parameter of the `Set-SPSiteSubscriptionIRMConfig` cmdlet to se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` site = Get-SPSite HYPERLINK "https://" https:// @@ -43,8 +41,7 @@ Set-SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled -Certificate This example enables IRM for the tenant and configures it to use the specified RMS server. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` site = Get-SPSite HYPERLINK "https://myspserver" https:// @@ -55,17 +52,18 @@ Set- SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled:$false This example disables IRM for the tenant. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a site subscription for a particular tenant. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -75,6 +73,9 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether IRM is enabled in the tenant. The default value is false. @@ -82,8 +83,7 @@ The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +107,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +117,15 @@ Accept wildcard characters: False ``` ### -CertificateServerUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the address of the RMS certificate server to use for the tenant. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +145,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -148,13 +154,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the output object can be passed through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -171,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionMetadataConfig.md index 02dd4128e..c6299e23a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionMetadataConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the site subscription configuration settings for a specified Metadata Service application. - ## SYNTAX ``` @@ -30,20 +29,21 @@ Use the `Set-SPSiteSubscriptionMetadataConfig` cmdlet to set the site subscripti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -HubUri "https://sitename" -SyndicationErrorReportEnabled:$false ``` This example sets the content type syndication hub and disables syndication error reporting for a specific site subscription on an existing partitioned Metadata Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site subscription for which to set the Metadata Service application settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the local metadata service proxy for the service application that contains the site subscription-specific settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -69,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -DoNotUnpublishAllPackages + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{ Fill DoNotUnpublishAllPackages description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI of the syndication hub. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -142,8 +152,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +162,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables error reporting for content type syndication. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionProfileConfig.md index 265b802f7..7151e1af1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteSubscriptionProfileConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the parameters of a site subscription. - ## SYNTAX ### Default @@ -43,10 +42,9 @@ The `Set-SPSiteSubscriptionProfileConfig` cmdlet sets the parameters of a site s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` $sub = Get-SPSiteSubscription http://contoso/my Set-SPSiteSubscriptionProfileConfig -Identity $sub -SiteNamingConflictResolution 3 -SynchronizationOU OrgUnit1 @@ -54,10 +52,12 @@ Set-SPSiteSubscriptionProfileConfig -Identity $sub -SiteNamingConflictResolution This example sets the parameter of the site subscription SiteNamingConflictResolution to always avoid any conflicts and parameter SynchronizationOU to OrgUnit1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the User Profile Service application that contains the site subscription to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -65,8 +65,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -76,15 +75,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection where the My Site host for the site subscription is provisioned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -93,27 +94,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +### -ProfileServiceApplicationProxy -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 -### -ProfileServiceApplicationProxy Specifies the name of the proxy for the User Profile Service application. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -123,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -162,6 +156,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -169,8 +166,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +176,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -198,8 +197,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +207,9 @@ Accept wildcard characters: False ``` ### -SynchronizationOU + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the organizational unit that serves the site subscription. The type must be a valid name of an organizational unit; for example, OrgUnit1. @@ -216,8 +217,7 @@ The type must be a valid name of an organizational unit; for example, OrgUnit1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,6 +227,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -234,7 +237,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteURL.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteURL.md index aafa4f56c..4171d8ee1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteURL.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSiteURL.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Adds or changes an URL mapping for the site. - ## SYNTAX ``` @@ -31,10 +30,9 @@ This cmdlet cannot be directly run against a managed path site collection undern For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` C:\PS>$site = Get-SPSite 'http://www.contoso.com' @@ -44,18 +42,19 @@ Set-SPSiteURL -Identity $site -Url http://contoso.sharepoint.com -Zone 0 This example adds an additional URL, http://contoso.sharepoint.com, to the site collection. The newly added URL is in the default zone. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site collection to set. Must be the root site collection for a host-name. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL. This must be unique. This must be an absolute URL including scheme (that is, https://www.contoso.com). @@ -74,8 +76,7 @@ Otherwise, the URL entry is added and cannot be in use by another site collectio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -141,16 +148,17 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one of the five zones with which the alternate URL is associated. If the Zone parameter is not specified and is a new entry, the default value is set. If an entry exists and is not specified, do not change. - ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplication.md index 10dff7cde..aaa08a080 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the name of a state service application. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The `Set-SPStateServiceApplication` cmdlet updates the name of a state service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPStateServiceApplication -Identity "State Service Application 1" -Name "New name for State Service Application 1" ``` This example changes the display name of a state service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to update. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -49,8 +49,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the state service application. The type must be a valid name of a state service application; for example, StateSvc1. @@ -106,8 +112,7 @@ The type must be a valid name of a state service application; for example, State ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplicationProxy.md index d3d9bf9b7..bcb0414e4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceApplicationProxy.md @@ -27,20 +27,21 @@ The `Set-SPStateServiceApplicationProxy` cmdlet updates the name of a state serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` Set-SPServiceApplicationProxy -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Name "New Service Application Proxy Name" ``` This example changes the display name of a state service application proxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application proxy to update. The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplicationProxy object. @@ -48,8 +49,7 @@ The type must be a valid name of a state service application proxy (for example, ```yaml Type: SPStateServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,13 +83,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{ Fill Confirm Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +101,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the display name of the state service application proxy. The type must be a valid name of a state service application; for example, StateSvcProxy1. @@ -104,8 +111,7 @@ The type must be a valid name of a state service application; for example, State ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{ Fill WhatIf Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceDatabase.md index ebfe41bb8..bcb427618 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPStateServiceDatabase.md @@ -28,26 +28,23 @@ The `Set-SPStateServiceDatabase` cmdlet manages the credentials that are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Weight 10 ``` This example updates the database weight to the maximum (10). - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -ServiceApplication "StateSvcApp1" ``` This example updates the associated service application for a state service database. - -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` C:\PS>$cred = Get-Credential @@ -56,10 +53,12 @@ Set-SPStateServiceDatabase -Identity "StateSvcDB1" -DatabaseCredentials $cred This example updates the SQL Authentication credentials that are used for a given database. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service database to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -68,7 +67,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -78,6 +76,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state service application to which to add the state database. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -86,7 +87,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) Aliases: Application -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: 1 @@ -96,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +110,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -135,6 +139,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -143,8 +150,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +160,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the weight for the state database. The default value is 1. @@ -162,8 +171,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +181,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -180,7 +191,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSubscriptionSettingsServiceApplication.md index c334d34e5..dd560c3f1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSubscriptionSettingsServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPSubscriptionSettingsServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a subscription settings service application. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Use the `Set-SPSubscriptionSettingsServiceApplication` cmdlet to set properties For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE-------------------------- +### EXAMPLE ``` C:\PS>$applicationPool = GetServiceApplicationPool SettingsApplicationPool @@ -43,10 +41,12 @@ Get-SPServiceApplication -Name SettingsServiceApp | Set-SPSubscriptionSettingsSe This example changes the application pool of the subscription settings service application. This command assumes that a subscription settings service application named SettingsServiceApp exists and that an application pool named SettingsApplicationPool exists - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the settings service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -111,8 +117,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the subscription settings database. The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsAppDB1. @@ -129,8 +137,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL Server instance for the database specified in DatabaseName parameter. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -147,8 +157,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -165,8 +177,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPThrottlingRule.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPThrottlingRule.md index adb021c93..e8345739d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPThrottlingRule.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPThrottlingRule.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes properties of an existing throttling rule. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the `Set-SPThrottlingRule` cmdlet to change the properties of an existing th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ``` C:\PS>$web=Get-SPWebApplication -Identity @@ -49,17 +47,18 @@ Set-SPThrottlingRule -Identity $ throttlingrule -Criteria $criteriaNew -Threshol This example sets throttling rule property - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the throttling rule object to set. ```yaml Type: SPThrottlingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +82,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +92,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +128,16 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a value between 0 and 10 which defines the maximum threshold for throttling. The Request Manager will remove routing targets if the Health-Score becomes greater than this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTimerJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTimerJob.md index a7375e865..3d128d219 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTimerJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTimerJob.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the schedule for running a timer job. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Set-SPTimerJob` cmdlet sets the schedule for running a specified timer job. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ``` Get-SPTimerJob job-recycle-bin-cleanup | Set-SPTimerJob -Schedule "weekly at sat 5:00" ``` @@ -41,6 +39,9 @@ This example sets the schedule to run the job-recylce-bin-cleanup timer job to w ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the timer job to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -48,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the schedule for running the timer job. The type must be a valid SharePoint Timer service (SPTimer) schedule in the form of any one of the following schedules: @@ -112,8 +119,7 @@ The type must be a valid SharePoint Timer service (SPTimer) schedule in the form ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +129,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplication.md index 440429eb6..6f38be1fe 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the properties on the topology service application of the local farm. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The `Set-SPTopologyServiceApplication` cmdlet sets the advanced properties of an For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPTopologyServiceApplication 67877d63-bff4-4521-867a-ef4979ba07ce -LoadBalancedURL "https://testurl" ``` @@ -42,10 +40,12 @@ This example sets the load-balanced URL for the topology service application. The topology service application GUID is unique to every farm. You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the application to be set. The type must be a valid GUID, in the form 1234-456-854gh. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 1234-456-854gh. ```yaml Type: SPTopologyWebServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -LoadBalancerUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an external physical load balancer. The type must be a valid URL, in the form http://search. @@ -71,8 +73,7 @@ The type must be a valid URL, in the form http://search. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplicationProxy.md index 8c3e81d60..4684e235e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTopologyServiceApplicationProxy.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the proxy properties of the topology service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Set-SPTopologyServiceApplicationProxy` cmdlet sets the properties of the lo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPTopologyServiceApplicationProxy 67877d63-bff4-4521-867a-ef4979ba07ce -BadListPeriod 1234 ``` @@ -41,10 +39,12 @@ This example sets the bad list period for the given topology service application The topology service application GUID is unique to every farm. You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the application proxy. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -52,8 +52,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -BadListPeriod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time period that a node is kept in a bad list. The type must be a valid value between 1 and 480 (in minutes). @@ -72,8 +74,7 @@ The default value is 10. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +98,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplication.md index 4c5a223eb..190149fce 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplication.md @@ -40,17 +40,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ``` Set-SPTranslationServiceApplication TranslationService -JobExpirationDays 14 -TotalActiveProcesses 3 ``` This example sets the job expiration to 14 days and the number of worker processes per server to 3 for the Machine Translation Service application named TranslationService. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the instance of the Machine Translation service to set. The type must be a valid URL in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -58,8 +60,7 @@ The type must be a valid URL in the form, https://server_name or a valid GUID (f ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +70,9 @@ Accept wildcard characters: False ``` ### -AddEnabledFileExtensions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Comma delimited list of file extensions that you want to add to the set of enabled file extensions for the Machine Translation Service application To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). @@ -76,8 +80,7 @@ To return a list of supported file extensions, type \[Microsoft.Office.Translati ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the managed application pool that the instance of Translation Service will run in. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -114,8 +122,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -ClearEnabledFileExtensions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Disables all file extensions for the Machine Translation Service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,14 +169,16 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database name which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the database server which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,13 +224,15 @@ Accept wildcard characters: False ``` ### -DisableBinaryFileScan + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether Gatekeeper is run on binary files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -223,13 +242,15 @@ Accept wildcard characters: False ``` ### -EnableAllFileExtensions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Enables all file extensions for the Machine Translation Service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -239,13 +260,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -255,13 +278,15 @@ Accept wildcard characters: False ``` ### -JobExpirationDays + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the amount of days after which completed jobs can be automatically removed from the Machine Translation Service queue database. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -271,6 +296,9 @@ Accept wildcard characters: False ``` ### -KeepAliveTimeout + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the length of time (in seconds) that the worker can be inactive before it is automatically stopped. The valid values are 60 to 600. @@ -279,8 +307,7 @@ The default value is 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -290,14 +317,16 @@ Accept wildcard characters: False ``` ### -MachineTranslationAddress + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the service URL the service application will use to call the translation provider. For example, https://api.microsofttranslator.com/v2/soap.svc ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -307,13 +336,15 @@ Accept wildcard characters: False ``` ### -MachineTranslationCategory + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the category which will be used by the service when calling the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -323,13 +354,15 @@ Accept wildcard characters: False ``` ### -MachineTranslationClientId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the AppId which will be used by the service when calling the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -339,6 +372,9 @@ Accept wildcard characters: False ``` ### -MaximumBinaryFileSize + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain binary data. The valid values are 100 to 524288. The default value is 51200. @@ -346,8 +382,7 @@ The default value is 51200. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -357,6 +392,9 @@ Accept wildcard characters: False ``` ### -MaximumItemsPerDay + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items which can be added to the job queue in a 24-hour period. A value of zero indicates no limit. @@ -367,8 +405,7 @@ The default value is zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -378,6 +415,9 @@ Accept wildcard characters: False ``` ### -MaximumItemsPerPartitionPerDay + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items which can be added to the job queue in a 24-hour period per partition. A value of zero indicates no limit. @@ -388,8 +428,7 @@ The default value is zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -399,6 +438,9 @@ Accept wildcard characters: False ``` ### -MaximumSyncTranslationRequests + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of items which can be added to the sync queue. A valid of zero indicates no limit. @@ -408,8 +450,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -419,6 +460,9 @@ Accept wildcard characters: False ``` ### -MaximumTextFileSize + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain mostly text data. The valid values are 100 to 15360. The default value is 5120. @@ -426,8 +470,7 @@ The default value is 5120. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -437,6 +480,9 @@ Accept wildcard characters: False ``` ### -MaximumTranslationAttempts + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum number of attempts an unsuccessful job is tried before it is marked as Failed. The valid values are 1 to 10. @@ -445,8 +491,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -456,6 +501,9 @@ Accept wildcard characters: False ``` ### -MaximumTranslationTime + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum length of time (in minutes) that a translation can take. The valid values are 60 to 3600. @@ -464,8 +512,7 @@ The default value is 600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -475,6 +522,9 @@ Accept wildcard characters: False ``` ### -MaximumWordCharacterCount + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum character count for a Microsoft Word document which can be translated. The valid Int values are 10000 to 10000000. @@ -483,8 +533,7 @@ The default value is 500000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -494,6 +543,9 @@ Accept wildcard characters: False ``` ### -RecycleProcessThreshold + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of documents which are translated before a Translation Worker process is recycled. The valid values are 1 to 1,000. @@ -502,8 +554,7 @@ The default value is 100. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -513,6 +564,9 @@ Accept wildcard characters: False ``` ### -RemoveEnabledFileExtensions + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Comma delimited list of file extensions that you want to remove from the set of enabled file extensions for the Machine Translation Service application. To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). @@ -520,8 +574,7 @@ To return a list of supported file extensions, type \[Microsoft.Office.Translati ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -531,6 +584,9 @@ Accept wildcard characters: False ``` ### -TimerJobFrequency + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the frequency (in minutes) with which the timer job for this service application runs. The valid values are 1 to 59. The default value is 15 minutes. @@ -538,8 +594,7 @@ The default value is 15 minutes. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -549,6 +604,9 @@ Accept wildcard characters: False ``` ### -TotalActiveProcesses + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of Translation Workers which are simultaneously running on a single machine. The valid values are 1 to 5. @@ -557,8 +615,7 @@ The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -568,6 +625,9 @@ Accept wildcard characters: False ``` ### -TranslationsPerInstance + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of translations dispatched to each service instance every time the timer job is run. Valid values are 1 to 1,000. @@ -576,8 +636,7 @@ The default value is 200. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -587,13 +646,15 @@ Accept wildcard characters: False ``` ### -UseDefaultInternetSettings + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Determines whether the service application will use default Internet settings for the user service account to connect to the translation provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -603,13 +664,15 @@ Accept wildcard characters: False ``` ### -WebProxyAddress + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the web proxy address and port that the service application will use to connect to the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -619,6 +682,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -626,7 +692,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplicationProxy.md index 10210881c..df863fd55 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationServiceApplicationProxy.md @@ -28,7 +28,7 @@ Use the `Set-SPTranslationServiceApplicationProxy` cmdlet to set properties on a ## EXAMPLES -### -------------EXAMPLE--------- +### EXAMPLE ``` Set-SPTranslationServiceApplicationProxy TranslationServiceProxy -DefaultProxyGroup ``` @@ -38,6 +38,9 @@ This example adds the Machine Translation Service application proxy named Transl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application proxy. The type must be a valid GUID in the form, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -45,8 +48,7 @@ The type must be a valid GUID in the form, 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: TranslationServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -95,13 +101,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -MaximumGroupSize + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Maximum number of bytes the proxy will send to the service in a single request. The valid values are 131072 to 10485760. The default value is 2097152. @@ -120,8 +131,7 @@ We do not recommend use of this parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +141,9 @@ Accept wildcard characters: False ``` ### -MaximumItemCount + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Maximum number of documents to be translated that the proxy will send to the service in a single request. The valid values are 1 to 40960. The default value is 9000. @@ -140,8 +153,7 @@ We do not recommend use of this parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationThrottlingSetting.md index f6a36209c..913c18d8a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationThrottlingSetting.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTranslationThrottlingSetting.md @@ -27,7 +27,7 @@ Use the Set-SPTranslationThrottlingSetting cmdlet to set the timer job duration ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ``` Set-SPTranslationThrottlingSetting -SiteQuota 300 -TenantQuota 600 ``` @@ -36,19 +36,20 @@ This limits the Translation Timer job to spend no more than 300 seconds (5 minut Note: TenantQuota must be greater than or equal to SiteQuota. - ## PARAMETERS ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -75,13 +78,14 @@ Accept wildcard characters: False ### -SiteQuota +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The duration (in seconds) of timer job processing time that an individual SPSite is limited to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +95,15 @@ Accept wildcard characters: False ``` ### -TenantQuota -The duration (in seconds) of timer job processing time that an individual tenant is limited to. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The duration (in seconds) of timer job processing time that an individual tenant is limited to. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +123,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedIdentityTokenIssuer.md index ff9d09a7f..09cc21ed2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedIdentityTokenIssuer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the identity providers of a Web application. - ## SYNTAX ### ImportCertificateParameterSet @@ -44,15 +43,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Set-SPTrustedIdentityTokenIssuer "LiveIDSTS" -Certificate (Get-ChildItem"cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") ``` This example sets the identity provider to LiveIDSTS. - -### -------------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` C:\PS>$ip = @( (Get-SPTrustedIdentityTokenIssuer "LiveID STS"), (New-SPTrustedIdentityTokenIssuer -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"), (Get-SPTrustedIdentityTokenIssuer "NTLM")) ) New-SPWebApplication https://contoso.com -IdentityProvider $ip @@ -61,10 +59,12 @@ New-SPWebApplication https://contoso.com -IdentityProvider $ip This example sets the identity provider using the .ASPNetMembership and Role parameters. When these parameters are used, a variable must be set; otherwise, the values do not take effect. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the identity provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. @@ -72,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -83,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +96,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +106,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IP STS that can resolve and search claims for claims people picker. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim provider (for example, MyIDprovider1); or an instance of a valid SPClaimProvider object. @@ -112,8 +116,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -ClaimsMappings + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the mapping of the claims from the original token to the SharePoint token. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. @@ -130,8 +136,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +146,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a description for the new identity provider. The type must be a valid string; for example, LiveID STS. @@ -148,8 +156,7 @@ The type must be a valid string; for example, LiveID STS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -ImportTrustCertificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -166,8 +176,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -177,11 +186,13 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the realm, or resource partition, associated with this trust. The type must be a name of a valid realm; for example, MD_REALM. @@ -198,8 +212,7 @@ The type must be a name of a valid realm; for example, MD_REALM. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +222,9 @@ Accept wildcard characters: False ``` ### -SignInUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign-in URLs for this trusted identity provider STS. The type must be a valid URL, in the form https://int.live.com/. @@ -216,8 +232,7 @@ The type must be a valid URL, in the form https://int.live.com/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,14 +242,16 @@ Accept wildcard characters: False ``` ### -UseWReply + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Includes a WReply with the token request. Wreply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -244,13 +261,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -260,13 +279,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill RegisteredIssuerName Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,6 +297,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -283,7 +307,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedRootAuthority.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedRootAuthority.md index d2858f090..eb82159db 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedRootAuthority.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Creates a new trusted root authority. - ## SYNTAX ### ManualUpdateCertificateParameterSet @@ -38,10 +37,9 @@ If a certificate file is used, the certificate must be an X509 certificate witho For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` C:\PS>$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 $cert.Import('C:\LiveIDSigningCert.pfx') @@ -50,10 +48,12 @@ Get-SPTrustedRootAuthority -Identity "WFEFarm1" | Set-SPTrustedRootAuthority -Ce This example updates the certificate of the trusted root authority WFEFarm1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted root authority to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -61,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +85,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate of the trusted root authority. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -101,8 +105,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill MetadataEndPoint Description}} ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +151,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -151,7 +161,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedSecurityTokenIssuer.md index fb2e6ed4f..32de4748c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedSecurityTokenIssuer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the trusted token issuer. - ## SYNTAX ### ImportCertificateParameterSet @@ -41,10 +40,9 @@ Use the `Set-SPTrustedSecurityTokenIssuer` cmdlet to set the trusted token issue For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ``` C:\PS>$a=Get-SPTrustedSecurityTokenIssuer @@ -53,17 +51,18 @@ Set-SPTrustedSecurityTokenIssuer -Identity $a -MetadataEndpoint https:// Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the id of the SPTrustedSecurityTokenIssuer object to be set. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +86,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,13 +96,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -IsTrustBroker + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,13 +169,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URI for the metadata endpoint of the issuer. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,11 +187,13 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -197,7 +213,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedServiceTokenIssuer.md index c732c90d4..c248b0500 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPTrustedServiceTokenIssuer.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates a trust with the farm. - ## SYNTAX ### ImportCertificateParameterSet @@ -38,10 +37,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -Certificate $cert @@ -49,18 +47,19 @@ Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -Certifica This example updates a SharePoint Farm trust using the trust certificate from a file. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml" ``` This example updates a SharePoint farm trust using the trust certificate from the federation metadata endpoint URL. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the trusted service token issuer to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -68,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -79,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +101,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -108,8 +111,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +121,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. @@ -126,8 +131,7 @@ The type must be a valid string; for example, WFE Farm Trust1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,13 +141,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -153,13 +159,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill MetadataEndPoint Description}} ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +177,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -176,7 +187,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageApplication.md index d2e92cedc..734cd5eb0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets properties of a usage application. - ## SYNTAX ``` @@ -30,20 +29,21 @@ The `Set-SPUsageApplication` cmdlet sets properties of a usage application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE---------------------- +### EXAMPLE ``` Set-SPUsageApplication -Identity "Usage and Health data collection" -DatabaseServer "Server Name" -DatabaseName "New Logging DB" ``` This example changes the database server and database name used by the usage logging service to store logging data. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a usage application (for example; UsageApp1); or an instance of a valid SPServiceApplication object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the logging database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -110,8 +116,7 @@ If the logging database does not exist, a logging database will be automatically ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -129,8 +137,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -147,8 +157,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +167,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -166,8 +178,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -177,13 +188,15 @@ Accept wildcard characters: False ``` ### -EnableLogging + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this usage application collects usage data. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -193,11 +206,13 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -207,6 +222,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPUsageService object that is the parent of the usage application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -214,8 +232,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +242,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -232,7 +252,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageDefinition.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageDefinition.md index 6dfdf6d55..960adab11 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageDefinition.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageDefinition.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the retention period for a usage provider. - ## SYNTAX ``` @@ -30,20 +29,21 @@ A usage definition object defines a specific type of usage provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ``` Set-SPUsageDefinition -Identity "Page Requests" -DaysRetained 31 ``` This example sets the number of days that stores page requests usage data to 31. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage definition object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. @@ -51,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -DaysRetained + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days that usage data for the usage provider is retained in the usage service database. The default value is 14. @@ -109,8 +115,7 @@ The type must be an integer between 0 and 31. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +125,16 @@ Accept wildcard characters: False ``` ### -DaysToKeepUsageFiles + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of days to keep usage file retention. The value must be less than or equal to value of the DaysRetained parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,13 +144,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Turns on the specified usage provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +162,15 @@ Accept wildcard characters: False ``` ### -MaxTotalSizeInBytes + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + This parameter stores the maximum SQL storage size for the data of this provider. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -UsageDatabaseEnabled + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Set to export usage data from the local server to the Usage database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageService.md index 4f716aeb2..da41d187d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUsageService.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the properties of a usage service. - ## SYNTAX ``` @@ -30,25 +29,25 @@ If the Identity parameter is not specified, the cmdlet applies the changes to th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------- +### EXAMPLE ``` Set-SPUsageService -LoggingEnabled $false Set-SPUsageService -UsageLogLocation "D:\\testusagelogdir" - Set-SPUsageService -UsageLogCutTime 5 ``` The examples disables usage logging, changes the directory where usage files are stored and creates a new usage log file every 5 minutes. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the usage service to update. The type must be in one of the following forms: @@ -60,8 +59,7 @@ The type must be in one of the following forms: ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -71,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -100,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,13 +112,15 @@ Accept wildcard characters: False ``` ### -LoggingEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that usage data is logged to usage files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +130,9 @@ Accept wildcard characters: False ``` ### -UsageLogCutTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in minutes, of usage data that is collected per usage log file. The default time is 5 minutes. @@ -134,8 +141,7 @@ The value must be an integer in the range of 1 to 1440. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +151,9 @@ Accept wildcard characters: False ``` ### -UsageLogLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path on every computer in the farm where usage log files are created. The value must be a valid local path in the following form: @@ -154,8 +163,7 @@ The value must be a valid local path in the following form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +173,9 @@ Accept wildcard characters: False ``` ### -UsageLogMaxFileSizeKB + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum size of a single usage file that is applied to all the usage providers. The minimum value is 512 kilobytes (KB) and the maximum value is 65536 KB. @@ -172,8 +183,7 @@ The minimum value is 512 kilobytes (KB) and the maximum value is 65536 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +193,16 @@ Accept wildcard characters: False ``` ### -UsageLogMaxSpaceGB + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum amount of space (measured in gigabytes) allowed for usage logs. Althought the parameter is present in later SharePoint Server versions, it is applicable only to SharePoint Server 2010. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +212,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -207,7 +222,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUser.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUser.md index 43eaa82ad..b04d6f13c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPUser.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures properties of an existing user. - ## SYNTAX ``` @@ -30,18 +29,16 @@ The `Set-SPUser` cmdlet configures properties of an existing user. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -AddPermissionLevel "Contributor" ``` This example sets a user (Contoso\jdoe) to be a contributor on https://intranet.contoso.com. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -SyncFromAD ``` @@ -51,6 +48,9 @@ This updates the User Information List for the user 'contoso\jdoe' with the curr ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID, login name, or SPUser object of the user to be returned. The type must be a GUID of an existing user in the form, 1234-5678-9876-0987. @@ -59,7 +59,6 @@ The type must be a GUID of an existing user in the form, 1234-5678-9876-0987. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AddPermissionLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the permission level to add to the user. The value must be one of the following options: @@ -96,8 +98,7 @@ Can view pages and list items and download documents. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +108,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -118,8 +122,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +132,16 @@ Accept wildcard characters: False ``` ### -ClearPermissions + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deletes all assigned permissions from the user. If Clear and Add values exist, permissions are first cleared and then new permissions are added. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +161,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -163,6 +170,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new display name of the user. The type must be a valid name. @@ -170,8 +180,7 @@ The type must be a valid name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +190,15 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new email address of the user. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,13 +208,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds the user to an existing group in the given site. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +226,15 @@ Accept wildcard characters: False ``` ### -IsSiteCollectionAdmin + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to set the user as a site collection administrator. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -229,14 +244,16 @@ Accept wildcard characters: False ``` ### -PassThru -If not provided, indicates that this cmdlet has no output. + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +If not provided, indicates that this cmdlet has no output. If provided, this parameter indicates that the SPUser object for this user is to be returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -246,13 +263,15 @@ Accept wildcard characters: False ``` ### -RemovePermissionLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Removes the permission level from the user. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -262,13 +281,15 @@ Accept wildcard characters: False ``` ### -SyncFromAD + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If provided, specifies that user information will be synchronized from the user directory store. This switch only retrieves the `displayName` and `mail` value from the directory store. It supports Active Directory (Classic or Windows authentication), Forms-based Authentication, and SAML. FBA and SAML providers must support resolving from their directory store for this switch to work. The switch only supports SharePoint User objects. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -278,6 +299,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the URL or GUID to be used as a scope. This parameter is not needed if the SPUser object is provided as the identity. @@ -286,8 +310,7 @@ The value must be an authentic URL, in the form https://server_name, or GUID, in ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +320,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -304,7 +330,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioExternalData.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioExternalData.md index d94b47963..d5cc943f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioExternalData.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioExternalData.md @@ -30,17 +30,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPVisioExternalData -VisioServiceApplication "VGS1" -UnattendedServiceAccountApplicationID "SSSApp1" ``` This example sets the unattended service account application ID to SSSApp1 for the Visio Services application named VGS1. - ## PARAMETERS ### -UnattendedServiceAccountApplicationID + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the target application ID in the registered secure store service that is used to reference unattended service account credentials. The unattended service account is a single account that all documents can use to refresh data. It is required when connecting to external data sources. @@ -51,8 +53,7 @@ The application ID must be registered in the secure store service application or ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioExternalData object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -69,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioPerformance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioPerformance.md index 078858e6d..8458ab561 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioPerformance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioPerformance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets performance properties for a Visio Services application. - ## SYNTAX ``` @@ -29,18 +28,16 @@ The `Set-SPVisioPerformance` cmdlet sets properties related to performance for a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 -MaxRecalcDuration 120 -MinDiagramCacheAge 1 -MaxDiagramCacheAge 4 ``` This example changes settings that are related to performance for a Visio Services application. - -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 ``` @@ -49,10 +46,12 @@ This example changes settings that are related to performance for a Visio Servic Note that only one setting value is specified. The cmdlet prompts you for the other parameter values. - ## PARAMETERS ### -MaxDiagramCacheAge + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in minutes, after which cached items are purged. This value affects memory use on the server. A large cache age slows the rate at which diagrams can be refreshed by users and reduces CPU and memory use of the server. @@ -63,8 +62,7 @@ The type must be an integer in the range of 0 to 34560 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,6 +72,9 @@ Accept wildcard characters: False ``` ### -MaxDiagramSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum size, in megabytes, of a diagram that can be opened by the Visio Services application. The default value is 5. @@ -82,8 +83,7 @@ The type must be an integer in the range of 1 to 50. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -MaxRecalcDuration + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum time, in seconds, that a diagram can only be recalculated by the Visio Services application. Diagram recalculation operations that take longer than this number of seconds are canceled by the service. A low value increases performance by allowing only simple diagrams to be processed by the server, which minimizes CPU and memory use. @@ -104,8 +107,7 @@ The default value is 60 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -115,6 +117,9 @@ Accept wildcard characters: False ``` ### -MinDiagramCacheAge + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the minimum time, in minutes, a diagram is cached in memory. This value affects memory use on the server. A small value allows users to refresh their diagrams more often, but will increase memory and CPU load of the server. @@ -125,8 +130,7 @@ The type must be an integer in the range of 0 to 34560 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -136,6 +140,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioPerformance object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -143,8 +150,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -154,6 +160,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -165,8 +174,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -176,13 +184,15 @@ Accept wildcard characters: False ``` ### -MaxCacheSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill MaxCacheSize Description}} ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioSafeDataProvider.md index 7b0d35645..fff3acadb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioSafeDataProvider.md @@ -28,18 +28,16 @@ The `Set-SPVisioSafeDataProvider` cmdlet sets the Description property of a safe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Set-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" ``` This example sets the description property of a safe data provider for a specific Visio Services application. - -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPVisioServiceApplication -Identity "VGS1" | Set-SPVisioSafeDataProvider -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" ``` @@ -47,10 +45,12 @@ Get-SPVisioServiceApplication -Identity "VGS1" | Set-SPVisioSafeDataProvider -Da This example sets the Description property of a safe data provider for a specific Visio Services application. The result is piped from the `Set-SPVisioSafeDataProvider` cmdlet. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the data provider to update. The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -61,8 +61,7 @@ The type must be a valid string that identifies the data provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the supported type of the data provider to get. Custom data types are supported; for example, Excel services. @@ -80,8 +82,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the description of the safe data provider to set. The type must be a string with a maximum of 4096 characters. @@ -98,8 +102,7 @@ The type must be a string with a maximum of 4096 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -116,8 +122,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +146,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioServiceApplication.md index fee29ab34..e8a0f6513 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPVisioServiceApplication.md @@ -28,18 +28,16 @@ The `Set-SPVisioServiceApplication` cmdlet sets the ServiceApplicationPool prope For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1---------------------- +### EXAMPLE 1 ``` Set-SPVisioServiceApplication -identity "VGS1" -ServiceApplicationPool "SharePoint Web Services System Default" ``` This example changes the application pool of the VGS1 service application. - -### -----------------EXAMPLE 2---------------------- +### EXAMPLE 2 ``` Get-SPServiceApplicationPool "SharePoint Web Services Default" | Set-SPVisioServiceApplication VGS1 ``` @@ -47,10 +45,12 @@ Get-SPServiceApplicationPool "SharePoint Web Services Default" | Set-SPVisioServ This example changes the application pool of the VGS1 service application. The results are piped from the `Get-SPServiceApplicationPool` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Visio Services application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -58,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the IIS application pool to change. The Web service for the service application runs in the specified application pool. @@ -77,8 +79,7 @@ The type must be a valid name of a Visio Service application pool, such as MyVis ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +142,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIBinding.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIBinding.md index 58fc053dc..93829aee8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIBinding.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIBinding.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the default click action for an application or file name extension binding. - ## SYNTAX ``` @@ -30,10 +29,9 @@ To do this, you set the default action to true for the "view"-"Word" bindings. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPWOPIBinding -Action "view" -Application "Word"| Set-SPWOPIBinding -DefaultAction:$true ``` @@ -42,17 +40,18 @@ This example sets the default click action to view for a Word document in a Shar You can verify that the default click action is set to view for Word by running the cmdlet `Get-SPWOPIBinding -Action "view" -Application "Word"`. The IsDefaultAction value is set to "True." - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the binding. ```yaml Type: SPWopiBindingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -DefaultAction + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether the binding should be set as the default click action for an application or file name extension in the binding. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +93,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIZone.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIZone.md index 75f66ea3c..f8ba77000 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIZone.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWOPIZone.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the zone that the current SharePoint farm will use to navigate the browser to the WOPI application. - ## SYNTAX ``` @@ -33,20 +32,21 @@ Only use HTTP when you are on a fully secure network that uses IPSEC (full encry For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Set-SPWOPIZone -Zone "external-https" ``` This example configures the current SharePoint farm to use external connections through HTTPS to the WOPI application (such as a server that runs Office Web Apps Server). - ## PARAMETERS ### -Zone + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the zone. For a list of zones that the WOPI application supports, run `Get-SPWOPIBinding`. @@ -63,8 +63,7 @@ The options are as follows: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -74,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +87,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -103,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWeb.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWeb.md index f4e471881..3ea264a64 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWeb.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the specified subsite. - ## SYNTAX ``` @@ -32,17 +31,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPWeb https://sitename/subweb | Set-SPWeb -Description "My Site Description" ``` This example sets the description of an existing subsite. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The URL of the Web or SPWeb object that represents the Web. The type must be a valid URL, in the form https://server_name, or an SPWeb object. @@ -50,8 +51,7 @@ The type must be a valid URL, in the form https://server_name, or an SPWeb obje ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,13 +61,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new description of the Web. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -77,14 +79,16 @@ Accept wildcard characters: False ``` ### -RelativeUrl + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new relative URL for the Web. This is the URL path after the site collection URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -94,13 +98,15 @@ Accept wildcard characters: False ``` ### -Theme + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new theme to apply to the Web. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,14 +116,16 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new template to apply to the Web. This cannot be done if the template is already applied. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +135,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +149,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +159,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +169,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplication.md index 5a19a1de6..262bfc53e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the specified Web application. - ## SYNTAX ### UpdateMailSettings @@ -64,10 +63,12 @@ Set-SPWebApplication http://somesite -Zone "Extranet" -HostHeader "http://www.co This example sets the HostHeader URL for the Extranet zone of the given Web application as http://www.contoso.com and enables anonymous access. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or URL of the Web application. The type must be a valid name, in the form WebApplication-1212, or URL, in the form http://server_name/WebApplicaiton-1212. @@ -75,8 +76,7 @@ The type must be a valid name, in the form WebApplication-1212, or URL, in the f ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -86,14 +86,16 @@ Accept wildcard characters: False ``` ### -OutgoingEmailAddress + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new outgoing e-mail address for e-mail messages sent from this Web application. The type must be a valid address; for example, someone@example.com. ```yaml Type: String Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +105,9 @@ Accept wildcard characters: False ``` ### -ReplyToEmailAddress + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Configures the reply e-mail address. The type must be a valid address; for example, someone@example.com. @@ -110,8 +115,7 @@ The type must be a valid address; for example, someone@example.com. ```yaml Type: String Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +125,15 @@ Accept wildcard characters: False ``` ### -SMTPServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new outbound SMTP server that this Web application will use. ```yaml Type: String Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +143,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When configuring zone-specific settings, the zone to configure must be specified. This zone must already exist. @@ -145,8 +154,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -156,13 +164,15 @@ Accept wildcard characters: False ``` ### -AdditionalClaimProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Adds a specific claim provider to the defined Web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +182,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -183,8 +196,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -194,14 +206,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Use to set a Web application to classic Windows authentication. The valid values are NTLM or Kerberos. ```yaml Type: String Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -211,13 +225,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Defines the authentication provider(s) that applies to the Web application. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -227,6 +243,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -234,7 +253,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -244,13 +262,15 @@ Accept wildcard characters: False ``` ### -DefaultQuotaTemplate + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new default site quota template for this Web application. ```yaml Type: String Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +280,15 @@ Accept wildcard characters: False ``` ### -DefaultTimeZone + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the default time zone for new site collections in this Web application. ```yaml Type: Int32 Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +298,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Suppresses confirmation messages involved in settings for a Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +316,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the farm's default proxy group is used. @@ -300,7 +327,6 @@ If this parameter is not specified, the farm's default proxy group is used. Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: UpdateGeneralSettings Aliases: ProxyGroup -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -310,13 +336,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -326,13 +354,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sign-in redirect URL for the Web application. ```yaml Type: String Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -342,6 +372,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -349,7 +382,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -359,13 +391,15 @@ Accept wildcard characters: False ``` ### -DisableSMTPEncryption + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill DisableSMTPEncryption Description}} ```yaml Type: SwitchParameter Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -375,13 +409,15 @@ Accept wildcard characters: False ``` ### -NotProvisionGlobally + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill NotProvisionGlobally Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -391,13 +427,15 @@ Accept wildcard characters: False ``` ### -SMTPServerPort + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + {{Fill SMTPServerPort Description}} ```yaml Type: Int32 Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplicationHttpThrottlingMonitor.md index 98bd648bc..c690c1cf5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplicationHttpThrottlingMonitor.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWebApplicationHttpThrottlingMonitor.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` C:\PS>$buckets=(2000,1000,500,300,200,100,50,30,20,10) Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint - @@ -41,8 +40,7 @@ Category Memory -Counter 'Available Mbytes' -IsDesc -HealthScoreBuckets $buckets This example sets the Health Score bucket values for the Memory\Available Mbytes counter to the array listed for the https://sharepoint Web application. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint 0 -Category Memory -Counter 'Available Mbytes' -IsDesc -UpperLimit 3000 @@ -50,10 +48,12 @@ Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint This example sets the upper limit for the Memory\Available Mbytes counter, the highest value in the Health Score buckets, to 3000 for the https://sharepoint Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -61,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the performance counter category. The type must be a valid performance counter category in the throttling monitor. @@ -80,8 +82,7 @@ Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of p ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 2 @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the performance counter. The type must be a valid performance counter in the throttling monitor. @@ -99,8 +103,7 @@ Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of p ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 3 @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +127,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -149,13 +156,15 @@ Accept wildcard characters: False ``` ### -HealthScoreBuckets + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies bucket ranges to use in determining the calculation of the server Health Score for this counter. ```yaml Type: Double[] Parameter Sets: (All) Aliases: Buckets -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -165,6 +174,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the instance of the performance counter. The default value is empty. If the specified value is invalid, this cmdlet will not run. @@ -172,8 +184,7 @@ If the specified value is invalid, this cmdlet will not run. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +194,9 @@ Accept wildcard characters: False ``` ### -IsDESC + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that this counter is interpreted in descending order. If this parameter is set, Health Score bucket values are interpreted in descending order; for example, set this parameter by using the Memory category and Available Mbytes counter to monitor available memory. @@ -190,8 +204,7 @@ If this parameter is set, Health Score bucket values are interpreted in descendi ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +214,9 @@ Accept wildcard characters: False ``` ### -LowerLimit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the lower limit of the numerical threshold of the specified performance counter. The lower limit is the lowest value in the Health Score bucket values. @@ -208,7 +224,6 @@ The lower limit is the lowest value in the Health Score bucket values. Type: Double Parameter Sets: (All) Aliases: Lower -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -218,6 +233,9 @@ Accept wildcard characters: False ``` ### -UpperLimit + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the upper limit of the numerical threshold of the specified performance counter. The upper limit is the highest value in the Health Score bucket values. @@ -225,7 +243,6 @@ The upper limit is the highest value in the Health Score bucket values. Type: Double Parameter Sets: (All) Aliases: Upper -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -235,6 +252,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -242,7 +262,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWordConversionServiceApplication.md index af893ef71..4d14025f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWordConversionServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWordConversionServiceApplication.md @@ -34,20 +34,21 @@ The `Set-SPWordConversionServiceApplication` cmdlet sets global properties of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE----------------- +### EXAMPLE ``` Get-SPServiceApplication -Name WordServices1 | Set-SPWordConversionServiceApplication -TimerJobFrequency 30 ``` This example sets the timer job frequency of the WordServices1 application to 30 minutes. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Word Automation Services application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. @@ -55,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: WordServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +66,9 @@ Accept wildcard characters: False ``` ### -ActiveProcesses + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of conversion processes on each machine on which the service application runs. This value is equivalent to the number of simultaneous conversions. The default value is 8. @@ -75,8 +78,7 @@ The type must be a valid integer in the range from 1 to 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +88,9 @@ Accept wildcard characters: False ``` ### -AddSupportedFormats + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a set of file formats to be enabled for use by the service application. The value must be a comma-delimited list of one or more of the following: docx, doc, mht, rtf, xml. @@ -93,8 +98,7 @@ The value must be a comma-delimited list of one or more of the following: docx, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +108,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing IIS managed application pool in which this instance of Word Automation Services runs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -111,8 +118,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -133,8 +142,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +152,15 @@ Accept wildcard characters: False ``` ### -ClearSupportedFormats + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that all file formats should be disabled for use by the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +170,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -167,7 +180,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -177,6 +189,9 @@ Accept wildcard characters: False ``` ### -ConversionsPerInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of items sent to each conversion process (see the ActiveProcesses parameter description earlier in this table) every time the timer job is run. The default value is 12. @@ -185,8 +200,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +210,9 @@ Accept wildcard characters: False ``` ### -ConversionTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time, in minutes, after which a conversion that is marked InProgress is confirmed to be still running each time the timer job runs and if necessary, the conversion is restarted. The default value is 5. @@ -204,8 +221,7 @@ The type must be a valid integer in the range from 1 to 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -215,6 +231,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials to use for connecting to the database for the Word Automation Services application. Use this parameter only if SQL Authentication is used to access the service application database. @@ -223,8 +242,7 @@ When the DatabaseCredential parameter is specified, the DatabaseName and Databas ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -234,6 +252,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the database to use for this instance of the Word Automation Services application. The type must be a valid SQL database name; for example, MetadataDB1. @@ -241,8 +262,7 @@ The type must be a valid SQL database name; for example, MetadataDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -252,6 +272,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the host server for the Word Automation Services database. The type must be a valid SQL database server host name; for example, SQLServerHost1. @@ -259,8 +282,7 @@ The type must be a valid SQL database server host name; for example, SQLServerHo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -270,14 +292,16 @@ Accept wildcard characters: False ``` ### -DisableBinaryFileScan + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether additional checks are run when Word documents are processed. Turn this setting off only if all documents processed by the service are trusted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -287,13 +311,15 @@ Accept wildcard characters: False ``` ### -DisableEmbeddedFonts + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether embedded fonts are ignored when present in input documents. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -303,6 +329,9 @@ Accept wildcard characters: False ``` ### -KeepAliveTimeout + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the length of time, in seconds, that a conversion can be non-responsive before it is terminated. The default value is 30. @@ -311,8 +340,7 @@ The type must be a valid integer in the range from 10 to 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -322,6 +350,9 @@ Accept wildcard characters: False ``` ### -MaximumConversionAttempts + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The maximum number of conversion attempts before a conversion is marked with status "Failed". The default value is 2. @@ -330,8 +361,7 @@ The type must be a valid integer in the range from 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -341,6 +371,9 @@ Accept wildcard characters: False ``` ### -MaximumConversionTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum length of time, in seconds, that a conversion can run before it is terminated. The default value is 300. @@ -349,8 +382,7 @@ The type must be a valid integer in the range from 60 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -360,6 +392,9 @@ Accept wildcard characters: False ``` ### -MaximumMemoryUsage + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the maximum percentage of system memory which can be used by the service application. The default value is 100. @@ -368,8 +403,7 @@ The type must be a valid integer in the range from 10 to 100. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -379,6 +413,9 @@ Accept wildcard characters: False ``` ### -RecycleProcessThreshold + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the number of documents which are converted before a conversion process is recycled. For additional information about the conversion process, see the ActiveProcess parameter description earlier in this table. @@ -387,8 +424,7 @@ The type must be a valid integer in the range from 1 to 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -398,6 +434,9 @@ Accept wildcard characters: False ``` ### -RemoveSupportedFormats + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a set of file formats to be disabled for use by the service application. The value must be a comma delimited list of one or more of the following: docx, doc, mht, rtf, xml. @@ -405,8 +444,7 @@ The value must be a comma delimited list of one or more of the following: docx, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -416,6 +454,9 @@ Accept wildcard characters: False ``` ### -TimerJobFrequency + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the frequency, in minutes, with which the timer job for this service application runs. The default value is 15. @@ -424,8 +465,7 @@ The type must be a valid integer in the range from 1 to 59. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -435,6 +475,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -442,7 +485,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -452,13 +494,15 @@ Accept wildcard characters: False ``` ### -MaximumGroupSize + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill MaximumGroupSize Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -468,13 +512,15 @@ Accept wildcard characters: False ``` ### -MaximumSyncConversionRequests + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill MaximumSyncConversionRequests Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplication.md index ba8f821ac..93e902ce1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplication.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ``` C:\PS>$wmservice = Get-SPServiceApplication -Name "Work Management Service Application" @@ -47,6 +47,9 @@ This example sets the minimum time between provider refreshes to 10 minutes on t ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPWorkManagementServiceApplication object @@ -54,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWorkManagementServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: 1 @@ -65,14 +67,16 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the name of an application pool to use; for example, SharePoint - 1213. If no value is specified, the default application pool is used. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named @@ -121,14 +129,16 @@ Accept wildcard characters: False ``` ### -MinimumTimeBetweenProviderRefreshes + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the minimum amount of time between cache update operations per user. If this time has not passed since the last successful refresh request for a user, the service application does not execute new refresh requests. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -138,14 +148,16 @@ Accept wildcard characters: False ``` ### -MinimumTimeBetweenSearchQueries -Specifies the minimum amount of time between calls to the Search Service application to discover new SharePoint task lists where a user has tasks. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + +Specifies the minimum amount of time between calls to the Search Service application to discover new SharePoint task lists where a user has tasks. If this time has not passed since the last successful call to Search for a user, the service application does not call Search during refresh operations. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -155,13 +167,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the name of the Work Management Service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -171,6 +185,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +195,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named @@ -188,13 +204,15 @@ Accept wildcard characters: False ``` ### -MinimumTimeBetweenEwsSyncSubscriptionSearches + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + This value specifies the minimum amount of time between calls into our routine that tries to find new tenants that want to sync EWS tasks. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -204,13 +222,15 @@ Accept wildcard characters: False ``` ### -NumberOfSubscriptionSyncsPerEwsSyncRun + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + This value specifies the maximum number of tenants the service will try to sync via EWS per Timer job interval ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -220,13 +240,15 @@ Accept wildcard characters: False ``` ### -NumberOfUsersEwsSyncWillProcessAtOnce + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + This value specifies the maximum number of users a service instance machine will sync via EWS at one time across all tenants. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -236,13 +258,15 @@ Accept wildcard characters: False ``` ### -NumberOfUsersPerEwsSyncBatch + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + This value specifies the maximum number of users a service instance will try to sync on a given tenant via EWS per Timer job interval ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplicationProxy.md index c778640ec..2348aaba0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplicationProxy.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkManagementServiceApplicationProxy.md @@ -30,17 +30,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------- +### EXAMPLE ``` Set-SPWorkManagementServiceApplicationProxy -Identity "9187d901-e0e0-4509-b117-9eca20d3ead5" -DefaultProxyGroup ``` This example makes the Work Management service part of the default proxy group. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPWorkManagementServiceApplicationProxy object @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWorkManagementServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies whether the Work Management Service application proxy is to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -114,14 +121,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Specifies the display name for the new Work Management Service application. For example, WorkManService1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 +Aliases: Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkflowConfig.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkflowConfig.md index 48a3e8ae4..f2cbd50a6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkflowConfig.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Set-SPWorkflowConfig.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Configures the workflow settings for the specified Web application. - ## SYNTAX ### SiteCollection @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Set-SPWorkflowConfig -webapplication https://sitename DeclarativeWorkflowsEnabled $true -EmailNoPermissionParticipantsEnabled $true -SendDocumentToExternalParticipants $false ``` @@ -55,10 +54,12 @@ No return values. Use the `Get-SPWorkflowConfig` cmdlet to see values. To set farm-level workflow settings for event-delivery time-out and to postpone threshold and batch size, use `Set-SPFarmConfig`. - ## PARAMETERS ### -SiteCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or URL of the site collection. The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. @@ -67,8 +68,7 @@ No other parameters are used. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -78,6 +78,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name or URL of the Web application. The type must be a valid name or GUID, in the form WebApplication-1212, or a URL, in the form https://server_name/WebApplication-1212. @@ -85,8 +88,7 @@ The type must be a valid name or GUID, in the form WebApplication-1212, or a URL ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -96,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +112,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +122,9 @@ Accept wildcard characters: False ``` ### -DeclarativeWorkflowsEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets whether declarative workflows are allowed to run in the Web application. The type must be either 1 for True or 0 for False. @@ -125,8 +132,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -EmailNoPermissionParticipantsEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets whether workflows send task e-mail messages to users who do not have permissions to the site in which the workflows are running. The type must be either 1 for True or 0 for False. @@ -143,8 +152,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +162,9 @@ Accept wildcard characters: False ``` ### -SendDocumentToExternalParticipants + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Sets whether workflows automatically send a copy of the document as an e-mail attachment to participants who do not have access to the site or who are not in any linked directory other than Active Directory Domain Services (AD DS). The type must be either 1 for True or 0 for False. @@ -161,8 +172,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +182,15 @@ Accept wildcard characters: False ``` ### -SingleWorkflowEpisodeTimeout + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Amount of time in seconds given to the workflow to run. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPScaleOutDatabase.md index 569fe8453..8b08b05b9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPScaleOutDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Moves a specified percentage of partitions from one scale-out database to another. - ## SYNTAX ### NewDatabase @@ -45,7 +44,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1--------------- +### EXAMPLE 1 ``` $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -56,7 +55,7 @@ This example creates a new scale-out database named Database2 on the MyDatabaseS The example also moves 30% of the data from the upper side of the data range in the first scale-out database of the given service application. -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ``` $ssa = Get-SPEnterpriseSearchServiceApplication @@ -71,13 +70,15 @@ This example scales out the Search Analytics database, moving 33% of data to the ## PARAMETERS ### -NewDatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of a new scale-out database that you are creating. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +88,15 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The source scale-out database to move data from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -103,13 +106,15 @@ Accept wildcard characters: False ``` ### -SourceServiceApplication + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The service application in which the data move operation will take place. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The target scale-out database to move data to. ```yaml Type: SPDatabasePipeBind Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -146,8 +156,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -164,7 +176,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -174,14 +185,16 @@ Accept wildcard characters: False ``` ### -MoveLowerHalf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -NewDatabaseCredentials + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the credentials to use when creating the scale-out database. These credentials will have owner rights on the newly created scale-out database. If a value is not provided, the current user's credentials will be used by default. @@ -198,8 +214,7 @@ If a value is not provided, the current user's credentials will be used by defau ```yaml Type: PSCredential Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +224,16 @@ Accept wildcard characters: False ``` ### -NewDatabaseFailoverServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the failover server name of the new scale-out database to be created. If a value is not provided, the new scale-out database does not have a failover server. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -226,14 +243,16 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the server of the new scale-out database to be created. If a value is not provided, the default database server is used. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -243,14 +262,16 @@ Accept wildcard characters: False ``` ### -SourcePercentage + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the percentage of data in the source scale-out database to move. If a value is not provided, the default value of 50 percent is used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -260,6 +281,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -267,7 +291,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPServerScaleOutDatabase.md index af70c7c15..54e449f18 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Split-SPServerScaleOutDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Moves a specified percentage of partitions from one scale-out database to another. - ## SYNTAX ### NewDatabase @@ -40,10 +39,9 @@ This cmdlet contains more than one parameter set. You may only use parameters fr Use the Split-SPServerScaleOutDatabase cmdlet to move a specified percentage of partitions from a source database to an existing target database or to a new database that you create with the specified parameters. - ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ``` $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -55,13 +53,15 @@ This example creates a new scale-out database named Database2 on the MyDatabaseS ## PARAMETERS ### -NewDatabaseName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of a new scale-out database that you are creating. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -71,13 +71,15 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The source scale-out database to move data from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -87,14 +89,15 @@ Accept wildcard characters: False ``` ### -SourceServiceApplication -The service application in which the data move operation will take place. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The service application in which the data move operation will take place. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -104,14 +107,15 @@ Accept wildcard characters: False ``` ### -TargetDatabase -The target scale-out database to move data to. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +The target scale-out database to move data to. ```yaml Type: SPDatabasePipeBind Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -121,16 +125,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -140,14 +145,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -157,14 +163,15 @@ Accept wildcard characters: False ``` ### -MoveLowerHalf -Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +181,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseCredentials -Specifies the credentials to use when creating the scale-out database. These credentials will have owner permissions on the new scale-out database. If you do not provide a value, the credentials of the logged on user will be used. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the credentials to use when creating the scale-out database. These credentials will have owner permissions on the new scale-out database. If you do not provide a value, the credentials of the logged on user will be used. ```yaml Type: PSCredential Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -191,14 +199,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseFailoverServer -Specifies the failover server name of the new scale-out database. If you do not provide a value, the new scale-out database does not have a failover server. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the failover server name of the new scale-out database. If you do not provide a value, the new scale-out database does not have a failover server. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -208,14 +217,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer -Specifies the name of the server of the new scale-out database. If you do not provide a value, the name of the default database server is used. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the name of the server of the new scale-out database. If you do not provide a value, the name of the default database server is used. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -225,14 +235,15 @@ Accept wildcard characters: False ``` ### -SourcePercentage -Specifies the percentage of data in the source scale-out database to move. If you do not provide a value, the default value, 50 percent, is used. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the percentage of data in the source scale-out database to move. If you do not provide a value, the default value, 50 percent, is used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -242,15 +253,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAdminJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAdminJob.md index 2816370bd..fc920cbfd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAdminJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAdminJob.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Immediately starts any waiting administrative job on the local computer. - ## SYNTAX ``` @@ -31,20 +30,21 @@ When you run this cmdlet in person (not in script), use the Verbose parameter to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Start-SPAdminJob -Verbose ``` This example runs all waiting administrative jobs and shows verbose output to the administrator. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,8 +56,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -74,7 +76,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAssignment.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAssignment.md index 7ff91c9fa..bd61d951b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAssignment.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPAssignment.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Initiates a new assignment store. - ## SYNTAX ``` @@ -44,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Start-SPAssignment -global $w = Get-SPWeb https://MyWeb @@ -56,8 +55,7 @@ This example uses simple assignment. Although it is easier to use simple assignment, it is not a good idea to run commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled. Ensure that you run `Stop-SPAssignment` before you attempt any iterations of multiple objects. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` $gc = Start-SPAssignment $web = $gc | Get-SPWeb https://MyWeb @@ -69,10 +67,12 @@ This example sets the title of the SPWeb object in multiple lines and controls t This is an advanced example. Only developers are advised to use it. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +84,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +94,9 @@ Accept wildcard characters: False ``` ### -Global + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + If you use this parameter, all objects are assigned to the lifetime of the script and are disposed of when the `Stop-SPAssignment` cmdlet is called. If you do not use this parameter, you must assign the output of this cmdlet to a variable and then dispose of objects by using the Identity parameter of the `Stop-SPAssignment` cmdlet. @@ -102,8 +104,7 @@ If you do not use this parameter, you must assign the output of this cmdlet to a ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPContentDeploymentJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPContentDeploymentJob.md index 56f59dcda..a9d240e4e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPContentDeploymentJob.md @@ -30,17 +30,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Job 1" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false | Start-SPContentDeploymentJob ``` This example creates a content deployment job Job 1 and runs it immediately. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content deployment job to run. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -DeploySinceTime + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the date to use to determine what changes to export incrementally. This parameter is ignored if the deployment job type is full. @@ -106,8 +114,7 @@ The type must be a valid DateTime type, in the form 2010,12,05. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -TestEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Runs the content deployment job in test mode only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -WaitEnabled + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the command is not returned until the operation is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -UseSpecificSnapshot + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Use a snapshot of the named Content Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPDiagnosticsSession.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPDiagnosticsSession.md index d16c75735..a2fda6a3c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPDiagnosticsSession.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPDiagnosticsSession.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Starts a diagnostic session to report diagnostic information to the usage database. - ## SYNTAX ``` @@ -29,10 +28,9 @@ After a diagnostic session starts, all Windows PowerShell for SharePoint cmdlets For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------- +### EXAMPLE ``` $correlationId = [guid]::NewGuid() Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -TraceLevel Verbose @@ -40,10 +38,12 @@ Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -Trace This example starts a diagnostic session for a specified correlation ID with the trace level of verbose. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +55,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -66,13 +65,15 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the correlation ID to be used for the diagnostic session. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Dashboard + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that diagnostics behave as if the developer dashboard were enabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Unified Logging Service (ULS) trace level override. --High @@ -108,12 +114,10 @@ Specifies the Unified Logging Service (ULS) trace level override. --VerboseEx --None - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index 48d8aa5fb..625c9f190 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -28,10 +28,9 @@ The `Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance` cmdlet starts For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance @@ -39,20 +38,20 @@ Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstan This example starts the local query and site settings instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search manager service instance to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. - ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchServiceInstance.md index 47b4500f9..80bbf1947 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPEnterpriseSearchServiceInstance.md @@ -30,20 +30,21 @@ For permissions and the most current information about Windows PowerShell for Sh If you run this cmdlet on a running search service instance, the associated search components are also restarted. This may lead to a short downtime for queries. - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPEnterpriseSearchServiceInstance -Local | Start-SPEnterpriseSearchServiceInstance ``` This example starts the local search service instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service instance to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -51,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPInfoPathFormTemplate.md index 9dfc9a235..573dbc702 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPInfoPathFormTemplate.md @@ -30,27 +30,27 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Start-SPInfoPathFormTemplate -Identity formName.xsn ``` This example activates a form with a specified name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to start. The type must be a valid URL, in the form https://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. - ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPProjectGenerateWsdl.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPProjectGenerateWsdl.md index b13ab4856..968c126f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPProjectGenerateWsdl.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPProjectGenerateWsdl.md @@ -27,16 +27,18 @@ Generates ASPX pages from WSDL files. ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Start-SPProjectGenerateWsdl ``` Generates ASPX files in C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\PSI from the pre-existing WSDL files. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -55,13 +56,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: Project Server 2016, Project Server 2019 + The path to the location containing the WSDL files. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPService.md index 6542d83f9..f6a673fe4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPService.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Enables a service in the farm. - ## SYNTAX ``` @@ -28,20 +27,21 @@ The Start-SPService cmdlet enables a service in the farm. Service instances for This cmdlet only controls service instances on servers that are managed by MinRole. The behavior for the Custom server role has changed with the November 2016 Public Update (PU). Please see the IncludeCustomServerRole parameter for additional information. - ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Start-SPService -Identity "Microsoft SharePoint Foundation Sandboxed Code Service" ``` This example enables the Microsoft SharePoint Foundation Sandboxed Code Service in the farm. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -76,13 +77,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service to enable. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -IncludeCustomServerRole + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Creates a timer job that also starts service instances on servers that are assigned to the custom server role. This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. @@ -99,8 +105,7 @@ This is a one-time Timer job. MinRole will make no further attempts to manage th ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -117,7 +125,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPServiceInstance.md index 5fcb3ac51..1e64555c6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPServiceInstance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Starts the service instance for a service on a specific server or the farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce ``` @@ -40,10 +39,12 @@ This example starts the given service instance on the server. The service instance GUID is unique to every farm. You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service instances and then use the result from the SPServiceInstance cmdlet for other cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service instance to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -51,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -62,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPTimerJob.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPTimerJob.md index ad3b1a35f..98e44848d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPTimerJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Start-SPTimerJob.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Runs a timer job once. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------- +### EXAMPLE ``` Get-SPTimerJob job-recycle-bin-cleanup | Start-SPTimerJob ``` @@ -40,6 +39,9 @@ This example starts the timer job named, job-recycle-bin-cleanup. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the timer job to run. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPAssignment.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPAssignment.md index 833d98770..e0c856322 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPAssignment.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPAssignment.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Disposes of objects in the provided assignment collection. - ## SYNTAX ``` @@ -30,10 +29,9 @@ Provide a SemiGlobal assignment collector to dispose of all contained objects. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Start-SPAssignment -global $w = Get-SPWeb https://MyWeb @@ -45,17 +43,18 @@ This example uses simple assignment. While easier to use simple assignment, running commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled is not recommended. Ensure that `Stop-SPAssignment` is run before attempting any iterations of multiple objects. - ## PARAMETERS ### -SemiGlobal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Provides the assignment collector from which to dispose of objects. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +88,15 @@ Accept wildcard characters: False ``` ### -Global + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Stops the global assignment collector from storing objects and disposes of any objects contained by the global assignment collector. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPContentTypeReplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPContentTypeReplication.md index 44e1f7bf1..a5fcbead1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPContentTypeReplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPContentTypeReplication.md @@ -26,7 +26,7 @@ Stops Content Type replication job from SharePoint Online and deletes the replic ## EXAMPLES -### -----------------EXAMPLE---------------- +### EXAMPLE ``` Stop-SPContentTypeReplication ``` @@ -35,6 +35,9 @@ Stops Content Type replication job from SharePoint Online. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -42,8 +45,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDiagnosticsSession.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDiagnosticsSession.md index 6a8ffc570..5cfe7b45e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDiagnosticsSession.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDiagnosticsSession.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Stops a diagnostic session. - ## SYNTAX ``` @@ -29,17 +28,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE--------- +### EXAMPLE ``` Stop-SPDiagnosticsSession ``` This example stops a diagnostic session. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDistributedCacheServiceInstance.md index a637d9d84..cfc7c3b25 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPDistributedCacheServiceInstance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Stops an instance of the Distributed Cache service on a local server. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------ Example 1 ---------- +### Example 1 ``` ``` @@ -39,13 +38,15 @@ Please see referenced article instead of using this cmdlet directly. ## PARAMETERS ### -Graceful + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to gracefully stop an instance of the Distributed Cache service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index 73f4d64e2..cc2cfe555 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance @@ -38,10 +38,12 @@ Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstanc This example stops the local query and site settings service instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search manager service instance to stop. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchServiceInstance.md index 96d6a7a23..3b5e7f131 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPEnterpriseSearchServiceInstance.md @@ -25,27 +25,28 @@ Stop-SPEnterpriseSearchServiceInstance [-Identity] Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the shared search service instance to stop. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -53,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPInfoPathFormTemplate.md index 2b9fb5cbf..d0789eb8c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPInfoPathFormTemplate.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Stop-SPInfoPathFormTemplate -Identity formName.xsn ``` @@ -41,6 +41,9 @@ This example disables a form template for a specified name. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -TimeLeft + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the time duration, in minutes, before the form template will be quiesced. The default value is 0. @@ -106,8 +115,7 @@ An integer value in the range from 0 to 1440. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPService.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPService.md index 1cbba94bf..229d4e929 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPService.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPService.md @@ -25,30 +25,31 @@ Stop-SPService [-Identity] [-AssignmentCollection Applicable: SharePoint Server 2016, SharePoint Server 2019 + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**Note**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the service to disable. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -90,14 +95,16 @@ Accept wildcard characters: False ``` ### -IncludeCustomServerRole + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Creates a timer job that also stops service instances on servers that are assigned to the custom server role. **Note**: This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +124,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPServiceInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPServiceInstance.md index c68391f1c..4c855db2e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPServiceInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPServiceInstance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Stops the service instance for a service. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Stop-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce ``` @@ -43,13 +42,15 @@ You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service in ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service instance to get. ```yaml Type: SPServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPTaxonomyReplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPTaxonomyReplication.md index 9ecf5ffef..b62593f20 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPTaxonomyReplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Stop-SPTaxonomyReplication.md @@ -27,7 +27,7 @@ Use the Stop-SPTaxonomyReplication cmdlet to terminate Hybrid SharePoint Taxonom ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Stop-SPTaxonomyReplication -Credential (Get-Credential) ``` @@ -37,6 +37,9 @@ This example performs a full replication and deletes the Taxonomy Groups Replica ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + This is the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. Fetches full taxonomy data properties, so a Term Store Administrator's credential is needed to perform the operations. @@ -62,8 +67,7 @@ Fetches full taxonomy data properties, so a Term Store Administrator's credentia ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPEnterpriseSearchServiceApplication.md index bbf2a2bc5..78b592485 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPEnterpriseSearchServiceApplication.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA $ssa | Suspend-SPEnterpriseSearchServiceApplication @@ -40,6 +40,9 @@ This example obtains a reference to a search service application named MySSA and ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to suspend. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPStateServiceDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPStateServiceDatabase.md index 31a088377..b042ee381 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Suspend-SPStateServiceDatabase.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` $db = Get-SPStateServiceDatabase Suspend-SPStateServiceDatabase -Identity $db @@ -41,6 +41,9 @@ This example suspends a specified state service database. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the state database to pause. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -49,7 +52,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Sync-SPProjectPermissions.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Sync-SPProjectPermissions.md index ca1e69060..5b5d4c268 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Sync-SPProjectPermissions.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Sync-SPProjectPermissions.md @@ -38,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Sync-SPProjectPermissions -Url https://pwa_site -Type Full ``` @@ -48,6 +48,9 @@ Performs a full sync against the PWA site https://pwa_site. ## PARAMETERS ### -Url + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the URL of the Project Web App instance for which you want to synch permissions. The type must be a valid URL, in the form https://pwa_site. @@ -55,8 +58,7 @@ The type must be a valid URL, in the form https://pwa_site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -SyncPWASite + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Triggers a synchronization of Project Server permissions to the PWA site. This parameter is used with Project Server permission mode. @@ -73,8 +78,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: 2 @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies the type of sync to perform: full or incremental. This parameter is used with SharePoint permission mode. @@ -95,8 +102,7 @@ Full, Incremental, AllGroups ```yaml Type: SharePointPermissionModeSyncType Parameter Sets: SPMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: 2 @@ -106,6 +112,9 @@ Accept wildcard characters: False ``` ### -SyncProjectSites + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Triggers a synchronization of Project Server permissions to the project sites. This parameter is used with Project Server permission mode. @@ -113,8 +122,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: 3 @@ -124,6 +132,9 @@ Accept wildcard characters: False ``` ### -Async + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies that the synchronization is placed in the Project Server queue. Omitting this flag causes the synchronization to occur immediately within the Windows PowerShell console. @@ -132,8 +143,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: 4 @@ -143,6 +153,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -154,8 +167,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPContentDatabase.md index 84c5e6b87..09f7b36b8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPContentDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Tests a content database. - ## SYNTAX ### ContentDatabaseById @@ -48,15 +47,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Test-SPContentDatabase -name WSS_Content_DB -webapplication https://sitename ``` This example tests the WSS_Content_DB content database against the sitename Web application and returns a list of issues. - -### ----------------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` $DB = Get-SPContentDatabase -site https://contoso.com Test-SPContentDatabase $DB -showrowcounts @@ -68,13 +66,15 @@ Together with displaying the list of issues, by specifying the ShowRowCounts par ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies an existing connected SharePoint content database to one of the two parameter sets in the form of a GUID or database name if it is unique. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -84,6 +84,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the existing content database to test. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -91,8 +94,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint Web application to use to test the content database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -109,8 +114,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -120,6 +124,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,8 +138,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +148,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -149,8 +158,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +168,9 @@ Accept wildcard characters: False ``` ### -ExtendedCheck + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Checks for inconsistent authentication modes during database-attach upgrade process. The selected mode, claims or classic, must be the same in both versions. @@ -167,8 +178,7 @@ The selected mode, claims or classic, must be the same in both versions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -178,6 +188,9 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the instance of the database service to use to test the specified content database. The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SQL Server instance (for example, DBSvrInstance1); or an instance of a valid SPDatabaseServiceInstance object. @@ -185,8 +198,7 @@ The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +208,9 @@ Accept wildcard characters: False ``` ### -ShowLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the locations where missing templates and features are being used within the database. Typically, reported locations are scoped within the site collections that are within the specified content database. @@ -204,8 +219,7 @@ The use of the parameter significantly increases the time to complete the test p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -215,13 +229,15 @@ Accept wildcard characters: False ``` ### -ShowRowCounts + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Returns database statistics which are row counts for tables in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPInfoPathFormTemplate.md index 0f84f9dc5..86f8bfb23 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPInfoPathFormTemplate.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Test-SPInfoPathFormTemplate -Identity formName.xsn ``` @@ -39,6 +39,9 @@ This example validates an InfoPath form template for a specified name. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path and name of the InfoPath form template to install. The type must be a valid path and file name of a form template, in the form: @@ -49,8 +52,7 @@ The type must be a valid path and file name of a form template, in the form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPO365LinkSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPO365LinkSettings.md index ec71f84cb..5c1591331 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPO365LinkSettings.md @@ -13,7 +13,7 @@ ms.reviewer: # Test-SPO365LinkSettings ## SYNOPSIS -Validates whether the configured Office 365 hybrid site uses a valid template. +Validates whether the configured Office 365 hybrid site uses a valid template. ## SYNTAX @@ -37,6 +37,9 @@ This example test a template using the contoso-my.sharepoint site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +51,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -58,13 +60,15 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -MySiteHostUrl + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The root URL for the redirected pages ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,7 +80,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectServiceApplication.md index 3c95d75d6..991d3fe5b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectServiceApplication.md @@ -28,7 +28,7 @@ This cmdlet runs a series of health checks against the Project Service Applicati ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Test-SPProjectServiceApplication -Identity $sa @@ -39,6 +39,9 @@ This example runs all health checks again the service application named "Project ## PARAMETERS ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +49,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + The name of the Project Service Application to test against. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 0 @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -Rule + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Which rule to run against the service application. Valid rules are: @@ -90,9 +97,8 @@ DatabasePermissions ```yaml Type: ProjectServiceApplicationHealthRuleName Parameter Sets: (All) -Aliases: +Aliases: Accepted values: All, QueueServiceInternalState, QueueInFlightJobs, CalcServiceWorkerState, DatabasePermissions -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectWebInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectWebInstance.md index ecf5d3a18..bf9023c5f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPProjectWebInstance.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ``` Get-SPProjectWebInstance | Test-SPProjectWebInstance ``` @@ -41,13 +41,15 @@ This example runs a suite of tests on all Project Web Instances in the SharePoin ## PARAMETERS ### -Identity + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Specifies a Project Web Instance. ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -Rule + +> Applicable: Project Server 2013, Project Server 2016, Project Server 2019 + {{Fill Rule Description}} ```yaml Type: ProjectSiteHealthRuleName Parameter Sets: (All) -Aliases: -Applicable: Project Server 2013, Project Server 2016, Project Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPSite.md index d32efab5d..af61a1b72 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Test-SPSite.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Activates the RunTests method against a referenced SPSite object. - ## SYNTAX ``` @@ -33,14 +32,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ``` Test-SPSite https:///sites/testsite ``` This example runs all the site collection health checks on the https://\/sites/testsite site collection. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ``` Test-SPSite https:// Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL or GUID of the site to run a test. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies one specific site health rule to run. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -RunAlways + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces a rule to run even if a health check was run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-FASTSearchAdminDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-FASTSearchAdminDatabase.md index e1eb9629e..aa2d78717 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-FASTSearchAdminDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-FASTSearchAdminDatabase.md @@ -34,7 +34,7 @@ For permissions and the most current information about FAST Search Server 2010 f ## EXAMPLES -### ---------------EXAMPLE 1----------------- (FAST Server for SharePoint 2010) +### EXAMPLE 1 (FAST Server for SharePoint 2010) ``` Uninstall-FASTSearchAdminDatabase -DbServer=sqlserver.contoso.com ``` @@ -45,13 +45,15 @@ All data will be deleted. ## PARAMETERS ### -DbConnection + +> Applicable: FAST Server for SharePoint 2010 + Specifies the database connection string for the FAST Search Server 2010 for SharePoint administration database, in the same format as the ConnectionString property of the System.Data.SqlClient.SqlConnection .NET Framework type. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -DbName + +> Applicable: FAST Server for SharePoint 2010 + Specifies the name of the FAST Search Server 2010 for SharePoint administration database. The name only takes effect when used in conjunction with the DbServer parameter, not the DbConnection parameter. @@ -68,8 +73,7 @@ The name only takes effect when used in conjunction with the DbServer parameter, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -DbServer + +> Applicable: FAST Server for SharePoint 2010 + Specifies the database server instance that contains the FAST Search Server 2010 for SharePoint administration database Only one of the DbServer and DbConnection parameters must be specified. @@ -87,8 +94,7 @@ Using DbServer with a value of sqlserver.contoso.com is equivalent to using DbCo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: FAST Server for SharePoint 2010 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPAppInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPAppInstance.md index 3f9730ef2..50c463186 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPAppInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPAppInstance.md @@ -15,8 +15,7 @@ ms.reviewer: ## SYNOPSIS Uninstalls an instance of an app. - -## SYNTAX +## SYNTAX ``` Uninstall-SPAppInstance -Identity [-AssignmentCollection ] [-Confirm] @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ``` $spapp = Get-SPAppInstance -AppInstanceId $instance.Id Uninstall-SPAppInstance -Identity $spapp @@ -39,17 +38,18 @@ Uninstall-SPAppInstance -Identity $spapp This example uninstalls an instance of an app. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app instance for which to find metadata. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPDataConnectionFile.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPDataConnectionFile.md index 2590d6085..3dd495617 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPDataConnectionFile.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Uninstall-SPDataConnectionFile -Identity "Sample.udcx "Sample1.udcx", "Sample2.udcx", "Sample3.udcx" | Uninstall-SPDataConnectionFile @@ -40,6 +40,9 @@ This example uninstalls a specified data connection file in two different ways. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the data connection file to remove. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPFeature.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPFeature.md index 8d7ae4a5d..45d1eaea1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPFeature.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPFeature.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Uninstalls an installed feature definition. - ## SYNTAX ``` @@ -30,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ``` Uninstall-SPFeature -Identity "MyCustomFeature" ``` This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ``` Uninstall-SPFeature -Identity "MyCustomFeature" -CompatibilityLevel 14 ``` @@ -47,6 +46,9 @@ This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the feature or GUID to uninstall. The type must be the name of the feature folder located in the \:\program files\common files\Microsoft Shared\Web server extensions\15\template\features folder, or must be a GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. @@ -54,8 +56,7 @@ The type must be the name of the feature folder located in the \:\progra ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -87,15 +90,16 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the version of feature to uninstall. When the version is not specified it will default to the web applications MaxVersion value. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -122,13 +128,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the uninstallation of a feature that is already installed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPHelpCollection.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPHelpCollection.md index 7f09128c2..de876221e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPHelpCollection.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPHelpCollection.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Removes Help collection files. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Uninstall-SPHelpCollection -Name "OSSAdmin.1033" ``` @@ -41,6 +40,9 @@ The folder name of the Help collection to uninstall is OSSAdmin.1033. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of the Help collection files to uninstall. The type must be a valid name of a Help collection; for example, HelpDocs1. @@ -48,8 +50,7 @@ The type must be a valid name of a Help collection; for example, HelpDocs1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPInfoPathFormTemplate.md index 3780b53e2..8419234d2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPInfoPathFormTemplate.md @@ -29,17 +29,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Uninstall-SPInfoPathFormTemplate -Identity formName.xsn ``` This example removes an InfoPath form template from a farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the InfoPath form template to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPSolution.md index 65f55959b..23f7359b0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPSolution.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Retracts a deployed SharePoint solution. - ## SYNTAX ### AllWebApplication @@ -43,10 +42,9 @@ Use the `Remove-SPSolution` cmdlet to delete the solution package from the solut For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Uninstall-SPSolution -Identity contoso_solution.wsp ``` @@ -56,6 +54,9 @@ This example retracts the deployed SharePoint solution contoso_solution.wsp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint solution to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -63,8 +64,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -74,13 +74,15 @@ Accept wildcard characters: False ``` ### -AllWebApplications + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new SharePoint solution will be uninstalled for all SharePoint Web applications in the farm. ```yaml Type: SwitchParameter Parameter Sets: AllWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Uninstalls the SharePoint solution for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -97,8 +102,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: OneWebApplication -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -108,6 +112,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -119,8 +126,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -147,13 +155,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +173,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Uninstalls the language pack for the specified language. The type must be a valid language identifier; for example, 1033. @@ -170,8 +183,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +193,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Uninstalls the solution from the active server computer. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +211,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies when the solution will be uninstalled. The default value is immediate retraction. @@ -205,8 +222,7 @@ The type must be a valid DateTime value, in the form 2010,12,05. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +232,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -223,7 +242,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPUserSolution.md index f93f7b589..b7a564917 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPUserSolution.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Deactivates a sandboxed solution in a site collection. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE--------------- +### EXAMPLE ``` Uninstall-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` @@ -41,6 +40,9 @@ This example deactivates the sandboxed solution contoso_solution.wsp on the site ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution to deactivate. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -48,8 +50,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deactivates the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. @@ -66,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPWebPartPack.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPWebPartPack.md index c944e5acb..67eb9e861 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPWebPartPack.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Uninstall-SPWebPartPack.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Uninstalls the specified Web Part package. - ## SYNTAX ``` @@ -31,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ``` Uninstall-SPWebPartPack "mypart.wpp" -WebApplication https://portal ``` This example uninstalls mypart.wpp to from the Web application https://portal. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ``` Get-SPWebPartPack -WebApplication https://portal | Uninstall-SPWebPartPack ``` @@ -48,13 +47,15 @@ This example uninstalls all Web part packages from the Web application https://p ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web Part package in the farm's configuration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the language ID of the Web Part package to delete. If no language is specified, the Web Part package is uninstalled for all languages. @@ -111,8 +119,7 @@ The type must be a valid language identifier, in the form 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Web application from which to uninstall the Web Part package. If no Web application is specified, the Web Part package is uninstalled from all Web applications. @@ -130,8 +140,7 @@ The type must be a valid name, in the form WebApplication-1212, or a URL, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -158,13 +169,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + {{Fill CompatibilityLevel Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Unpublish-SPServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Unpublish-SPServiceApplication.md index b6d95ea56..67671aa5f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Unpublish-SPServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Unpublish-SPServiceApplication.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Stops sharing the specified service application outside the farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` UnPublish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 ``` @@ -43,6 +42,9 @@ You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the GUID of the service application to stop sharing outside the farm. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppCatalogConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppCatalogConfiguration.md index ccbd405d7..16889a19e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppCatalogConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppCatalogConfiguration.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE----------- +### EXAMPLE ``` Update-SPAppCatalogConfiguration -Site https://contoso/sites/appcatalog_1 -Force:$true -SkipWebTemplateChecking:$true ``` @@ -38,14 +38,15 @@ This example sets https://contoso/sites/appcatalog_1 as the app catalog site col ## PARAMETERS ### -Site -Specifies the URL or GUID of the site collection to be set as the app catalog site collection. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the URL or GUID of the site collection to be set as the app catalog site collection. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -55,16 +56,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -74,14 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to force marking the site collection even if there are validation errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -SkipWebTemplateChecking + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to skip checking if the template of the site is APCATALOG#0. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -123,15 +130,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppInstance.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppInstance.md index 7abb7f1ad..c1eb72f8a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppInstance.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPAppInstance.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the app instance. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Update-SPAppInstance` cmdlet to update the app instance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------EXAMPLE--------- +### EXAMPLE ``` $spapp = Import-SPAppPackage -Path .\feature-upgrade-v2.spapp -Site https://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) C:\S>$instance = Get-SPAppInstance -AppInstanceId $instance.Id @@ -40,17 +38,18 @@ Update-SPAppInstance -Identity $instance -App $spapp This example updates an instance of an app. - ## PARAMETERS ### -App + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the app version to upgrade to. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies The app instance to upgrade. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPDistributedCacheSize.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPDistributedCacheSize.md index cfe09b7ea..4afb45a2e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPDistributedCacheSize.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPDistributedCacheSize.md @@ -27,25 +27,25 @@ Use the Update-SPDistributedCacheSize cmdlet to allocate memory to the Distribut ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ``` Update-SPDistributedCacheSize -CacheSizeInMB 2048 ``` Updates the Distributed Cache size to 2048MB. - ## PARAMETERS ### -CacheSizeInMB -Specifies the memory size in megabytes (MB) that you want to allocate to the Distributed Cache service. The default value is 5 percent of total system random access memory (RAM). This value should not be more than 40 percent of total system RAM with a maximum limit of 16 gigabytes (GB). +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies the memory size in megabytes (MB) that you want to allocate to the Distributed Cache service. The default value is 5 percent of total system random access memory (RAM). This value should not be more than 40 percent of total system RAM with a maximum limit of 16 gigabytes (GB). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -55,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +65,7 @@ NOTE: When the Global parameter is used, all objects are contained in the global ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPFarmEncryptionKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPFarmEncryptionKey.md index aacac36ab..11697d3da 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPFarmEncryptionKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPFarmEncryptionKey.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Changes the value of the farm encryption key and using the new key, re-encrypts all the data. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ``` Update-SPFarmEncryptionKey -confirm ``` @@ -41,6 +40,9 @@ This example changes the farm encryption key to a new value and re-encrypts all ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -70,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -Resume + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Resumes re-encryption of data with the new farm encryption key if a previous attempt failed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPHelp.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPHelp.md index 8e9877506..59d1290e4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPHelp.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPHelp.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates SharePoint cmdlet help. - ## SYNTAX ``` @@ -29,23 +28,22 @@ The computer that the cmdlet is being run on must have an internet connection. Note: This cmdlet currently does not update cmdlet help. - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ``` Update-SPHelp ``` Updates SharePoint cmdlet help. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ``` Update-SPHelp -Force ``` This example over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours. -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ``` Update-SPHelp -Verbose ``` @@ -55,6 +53,9 @@ This example checks for updates to the help files and provides detailed feedback ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +63,7 @@ NOTE: When the Global parameter is used, all objects are contained in the global ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -73,13 +73,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathAdminFileUrl.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathAdminFileUrl.md index 349318713..6e09caee3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathAdminFileUrl.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathAdminFileUrl.md @@ -32,10 +32,10 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPWebApplication http://contoso2010 | Update-SPInfoPathAdminFileUrl --find "http://contoso2007" +-find "http://contoso2007" -replace "http://contoso2010" ``` @@ -45,6 +45,9 @@ Data connections that reference http://contoso 2007 are updated to reference htt ## PARAMETERS ### -Find + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to find. The type must be a valid URL, in the form http://previous_server_name. @@ -52,8 +55,7 @@ The type must be a valid URL, in the form http://previous_server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to find. The type must be a valid URL, in the form http://server_name. @@ -70,8 +75,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -120,14 +128,16 @@ Accept wildcard characters: False ``` ### -Scan + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Run the tool and log the actions that can be taken. No content is changed as a result of the scan. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +147,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathFormTemplate.md index f3cba7a53..27340b209 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathFormTemplate.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ``` Update-SPInfoPathFormTemplate ``` @@ -40,6 +40,9 @@ This example updates InfoPath form templates on the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +54,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -69,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathUserFileUrl.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathUserFileUrl.md index ffde96858..4d08bb143 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathUserFileUrl.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPInfoPathUserFileUrl.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files). - ## SYNTAX ### ContentDB @@ -48,7 +47,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Get-SPWebApplication http://contoso2010 | Update-SPInfoPathUserFileUrl -Find "http://contoso2007" -Replace "http://contoso2010" ``` @@ -60,6 +59,9 @@ Data connections that reference http://contoso2007 are updated to reference http ## PARAMETERS ### -ContentDatabase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the parent content database where the update will start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content database (for example, SPContent DB1); or an instance of a valid SPContentDatabase object. @@ -67,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the parent site collection where the update will start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://sites/example; or an instance of a valid SPSite object. @@ -85,8 +89,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the parent SharePoint Web application where the update will start. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object @@ -103,8 +109,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApp -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -Find + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to find. The type must be a valid URL, in the form http://previous_server_name. @@ -121,8 +129,7 @@ The type must be a valid URL, in the form http://previous_server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL to find. The type must be a valid URL, in the form http://server_name. @@ -139,8 +149,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -150,6 +159,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -161,8 +173,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +193,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -189,14 +202,16 @@ Accept wildcard characters: False ``` ### -Scan + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Run the tool and log the actions that can be taken. No content is changed as a result of the scan. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +221,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -213,7 +231,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPProfilePhotoStore.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPProfilePhotoStore.md index c97d7db55..d33e54f63 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPProfilePhotoStore.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPProfilePhotoStore.md @@ -40,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------- +### EXAMPLE ``` Update-SPProfilePhotoStore -MySiteHostLocation https://mysites ``` @@ -50,13 +50,15 @@ This example uploads photos to a specified My Site host location. ## PARAMETERS ### -MySiteHostLocation + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the URL for the My Site host location where the photos are to be uploaded. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +82,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +92,15 @@ Accept wildcard characters: False ``` ### -CreateThumbnailsForImportedPhotos + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Creates thumbnails for all the imported user profile pictures. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +110,16 @@ Accept wildcard characters: False ``` ### -NewBaseUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the new URL for profile pictures. For example, https://server2/. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +129,9 @@ Accept wildcard characters: False ``` ### -NoDelete + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + When the value is set to true, imported user profile picture files will be preserverd after creating thumbnails for them. > [!NOTE] > This will only work when CreateThumbnailsForImportedPhotos is set to `$true` @@ -128,8 +139,7 @@ When the value is set to true, imported user profile picture files will be prese ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +149,16 @@ Accept wildcard characters: False ``` ### -OldBaseUri + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the old URL for profile pictures. For example, https://server1/. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogFeedCache.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogFeedCache.md index a0a38f688..87ca16cef 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogFeedCache.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogFeedCache.md @@ -55,7 +55,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------------ +### EXAMPLE 1 ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} @@ -64,7 +64,7 @@ Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -Ac This example refreshes the feed for a specific user by using the AccountName parameter. -### ------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell $site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0] @@ -79,7 +79,7 @@ while($profiles.MoveNext()) { This example refreshes the feeds for all users in the User Profile Service Application. -### ------------EXAMPLE 3------------ +### EXAMPLE 3 ```powershell Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -SiteUrl https://sharepoint.contoso.com @@ -91,13 +91,14 @@ This example refreshes the feed on the site https://sharepoint.contoso.com. ### -AccountName +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the user's account name for the User Profile Service application. ```yaml Type: String Parameter Sets: (All), Default Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -108,6 +109,8 @@ Accept wildcard characters: False ### -ProfileServiceApplicationProxy +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service application proxy to update. The type must be in one of the following forms: @@ -120,7 +123,6 @@ The type must be in one of the following forms: Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -131,6 +133,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -143,7 +147,6 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -154,14 +157,15 @@ Accept wildcard characters: False ### -SiteSubscription +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All), Default +Parameter Sets: (All), Default, FollowableList Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -170,28 +174,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -SiteUrl +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Site's URL to repopulate the site feeds. If you don't specify this parameter, you must specify the AccountName parameter. If neither parameter is specified, an error message is displayed. ```yaml Type: String Parameter Sets: (All), Default Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -202,13 +194,14 @@ Accept wildcard characters: False ### -ListId +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The ListId of the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -219,13 +212,14 @@ Accept wildcard characters: False ### -ListRootFolderUrl +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The RootFolderUrl of the FollowableList. ```yaml Type: String Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -236,13 +230,14 @@ Accept wildcard characters: False ### -SiteId +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The SiteId containing the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named @@ -253,13 +248,14 @@ Accept wildcard characters: False ### -WebId +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + The WebId containing the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogLMTCache.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogLMTCache.md index 2e24bc9d5..5db85638c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogLMTCache.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPRepopulateMicroblogLMTCache.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ``` $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Update-SPRepopulateMicroblogLMTCache -ProfileServiceApplicationProxy $proxy @@ -43,11 +43,13 @@ This example refreshes the cache for the specified proxy. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service application proxy to update. The type must be in one of the following forms: - --A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh --A valid name of a service application proxy (for example, UserProfileSvcProxy1) @@ -57,8 +59,7 @@ The type must be in one of the following forms: ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreApplicationServerKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreApplicationServerKey.md index b95a34d6d..7fbe988f8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreApplicationServerKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreApplicationServerKey.md @@ -36,7 +36,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $newPassPhrase = "abcDEF123!" $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} @@ -48,13 +48,15 @@ This example synchronizes the passphrase of the server key on a SharePoint serve ## PARAMETERS ### -Passphrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the passphrase that is used for the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the service application that contains the server key to synchronize. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +98,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreCredentialMapping.md index 6f681abbd..19248023a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreCredentialMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreCredentialMapping.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" $firstCredential = ConvertTo-SecureString "LOBDATABASE\jdoe" -AsPlainText -Force @@ -46,13 +46,15 @@ This user is mapped to a pair of credential values on the External System with a ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Store Service application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPClaims object that contains the principal. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -Values + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the field values for the credential mapping. ```yaml Type: SecureString[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -133,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreGroupCredentialMapping.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreGroupCredentialMapping.md index fc04f6dad..6db95b15a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreGroupCredentialMapping.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreGroupCredentialMapping.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoGroupTargetApplication" $firstCredential = ConvertTo-SecureString "LOBDATABASE\fulltimeemployees" -AsPlainText -Force @@ -47,13 +47,15 @@ These users are mapped to a pair of credential values on the External System wit ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -Values + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the field values for the credential mapping. ```yaml Type: SecureString[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -118,11 +126,13 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreMasterKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreMasterKey.md index 242bd6394..41bb7fbc6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreMasterKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSecureStoreMasterKey.md @@ -27,19 +27,17 @@ The `Update-SPSecureStoreApplicationServerKey` cmdlet changes the master key of Updating the master key is required when: - --A new instance of a service application is created and the database for the Secure Store service application is new or empty. --The master key or passphrase has been compromised. --Security guidelines require that the passphrase or key be replaced. - For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` $newPassPhrase = "abcDEF123!" $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} @@ -51,6 +49,9 @@ This example creates a new master key for the given service application. ## PARAMETERS ### -Passphrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the passphrase that is used for the Secure Store database. The passphrase that you enter is not stored. Make sure that you write down the passphrase and store it in a secure location. @@ -59,8 +60,7 @@ The passphrase will be required to add new Secure Store service servers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -70,13 +70,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the proxy of the Secure Store service application that contains the master key to update. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +102,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSolution.md index 9c61d817b..82c7ac152 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPSolution.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Upgrades a deployed SharePoint solution. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Update-SPSolution -Identity contoso_solution.wsp -LiteralPath c:\contoso_solution_v2.wsp -GACDeployment ``` @@ -43,6 +42,9 @@ This example upgrades the deployed SharePoint solution contoso_solution.wsp to ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SharePoint solution to deploy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -LiteralPath + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the path to the solution package. The type must be a valid path in either of the following forms: @@ -71,8 +75,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -CASPolicies + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that Code Access Security (CAS) policies can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -137,13 +146,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces the deployment of the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -GACDeployment + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies that the new SharePoint solution can be deployed to the global assembly cache (GAC). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Deploys the solution on the local computer only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies when the solution will be deployed. The default value is immediate deployment. @@ -193,8 +211,7 @@ The type must be a valid DateTime value, in the form 2010, 5, 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +221,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -211,7 +231,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -221,13 +240,15 @@ Accept wildcard characters: False ``` ### -FullTrustBinDeployment + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to deploy using fully trusted bin. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPUserSolution.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPUserSolution.md index 4eac02da6..d27fa1424 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPUserSolution.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPUserSolution.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Upgrades an activated sandboxed solution in a farm. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE--------------------- +### EXAMPLE ``` Update-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename -ToSolution contoso_solution_v2.wsp ``` @@ -43,6 +42,9 @@ This example upgrades the sandboxed solution contoso_solution.wsp in the site ht ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution to upgrade. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -50,8 +52,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Upgrade the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -68,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -ToSolution + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the sandboxed solution you want to upgrade to. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -86,8 +92,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -136,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPWOPIProofKey.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPWOPIProofKey.md index 053c6c4ab..556bb5ff2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPWOPIProofKey.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Update-SPWOPIProofKey.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Updates the public key that is used to connect to the WOPI application on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Update-SPWOPIProofKey -ServerName "Server.corp.Contoso.com" ``` @@ -42,6 +41,9 @@ This example obtains the current public key from the WOPI application (such as a ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +55,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -ServerName + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the WOPI application to obtain the key from. This may be a server that runs Office Web Apps Server. If this parameter is missing, public keys for all WOPI applications which are connected to the current SharePoint farm, are updated. @@ -71,8 +75,7 @@ If this parameter is missing, public keys for all WOPI applications which are co ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPAppManagementServiceApplication.md index 1938da408..8ff5521d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPAppManagementServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPAppManagementServiceApplication.md @@ -35,23 +35,24 @@ Do Not Use ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ``` Do Not Use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -DatabaseIds + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: Guid[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: AppManagementSvcAppById -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 0 @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do Not Use ```yaml Type: String Parameter Sets: AppManagementSvcAppByName -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -132,7 +144,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPContentDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPContentDatabase.md index 1eecd0c2f..60255258d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPContentDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPContentDatabase.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Resumes a failed database upgrade or begins a build-to-build database upgrade. - ## SYNTAX ### ContentDatabaseById @@ -43,7 +42,7 @@ Use the `Upgrade-SPContentDatabase` cmdlet to resume a failed database upgrade o The `Upgrade-SPContentDatabase` cmdlet initiates an upgrade of an existing content database that is attached to the current farm. This cmdlet begins a new upgrade session, which can be used either to resume a failed version-to-version or build-to-build upgrade of a content database or to begin a build-to-build upgrade of a content database. -If the database is hosted on a version of SQL Server that supports creation and use of snapshots of the database, this cmdlet can use a database snapshot for build-to-build upgrades. +If the database is hosted on a version of SQL Server that supports creation and use of snapshots of the database, this cmdlet can use a database snapshot for build-to-build upgrades. During upgrade, users see a ready-only version of the database, which is the snapshot. After upgrade users see upgraded content. @@ -52,10 +51,9 @@ To prevent build-to-build upgrades of site collections, use the NoB2BSiteUpgrade This cmdlet does not trigger version-to-version upgrade of any site collections. - ## EXAMPLES -### --------------------------EXAMPLE 1------------------------------ +### EXAMPLE 1 ``` Upgrade-SPContentDatabase WSS_Content ``` @@ -63,7 +61,7 @@ Upgrade-SPContentDatabase WSS_Content This example upgrades the existing WSS_Content content database schema and then performs only build-to-build upgrade actions on existing site collections if required. This operation does not changed the CompatibilityLevel for existing site collections in this database. -### --------------------------EXAMPLE 2------------------------------ +### EXAMPLE 2 ``` Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade ``` @@ -72,18 +70,21 @@ This example upgrades the existing WSS_Content content database schema only. No build-to-build upgrade actions are performed on any site collections. This operation does not change The CompatibilityLevel for existing site collections in this database. -### --------------------------EXAMPLE 3------------------------------ +### EXAMPLE 3 ``` Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade -UseSnapshot ``` -This example upgrades the existing WSS_Content content database schema only while using a snapshot of the database to retain read-only access to the content during the upgrade. +This example upgrades the existing WSS_Content content database schema only while using a snapshot of the database to retain read-only access to the content during the upgrade. No build-to-build upgrade actions are performed on any site collections. This operation does not change the CompatibilityLevel for existing site collections in this database. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the content database to upgrade. The value must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPContentDatabase object. @@ -91,8 +92,7 @@ The value must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -102,13 +102,15 @@ Accept wildcard characters: False ``` ### -ForceDeleteLock + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Forces deletion of locks on the database before the upgrade starts. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: 2 @@ -118,13 +120,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the name of attached content database. ```yaml Type: String Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -134,13 +138,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the web application that hosts the attached content database. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -150,6 +156,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -161,8 +170,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -189,13 +199,15 @@ Accept wildcard characters: False ``` ### -NoB2BSiteUpgrade + +> Applicable: SharePoint Server 2010, SharePoint Server 2013 + Specifies to not upgrade all child objects when performing a build-to-build upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013 +Aliases: Required: False Position: Named @@ -205,13 +217,15 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + The SQL Server instance that hosts the attached content database. ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -221,13 +235,15 @@ Accept wildcard characters: False ``` ### -SkipIntegrityChecks + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the upgrade process not to run the internal integrity checks such as missing templates and orphan detection as part of the upgrade process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +253,9 @@ Accept wildcard characters: False ``` ### -UseSnapshot + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to use the snapshot method to perform unattached upgrade. This will make a snapshot of the current database and then perform all upgrade operations that apply to the database and optionally to its contents. @@ -248,8 +267,7 @@ This parameter only works for versions of SQL Server that support creation and u ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -259,6 +277,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -266,7 +287,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -276,13 +296,15 @@ Accept wildcard characters: False ``` ### -AllowUnattached + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Lets the upgrade process to proceed on a content database which is not currently attached to a SharePoint farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -292,13 +314,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to not upgrade databases and their child objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplication.md index 7d64abb46..e7c743256 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplication.md @@ -34,21 +34,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1----------------- +### EXAMPLE 1 ``` Get-SPEnterpriseSearchServiceApplication | Upgrade-SPEnterpriseSearchServiceApplication ``` This example upgrades a search service application. -### ----------------EXAMPLE 2----------------- +### EXAMPLE 2 ``` Upgrade-SPEnterpriseSearchServiceApplication -Identity 846ceb0b-31d6-4c79-82c1-3a9deafe0b45 ``` This example upgrades a search service application. -### ----------------EXAMPLE 3----------------- +### EXAMPLE 3 ``` Upgrade-SPEnterpriseSearchServiceApplication "DefaultSearchApplication" ``` @@ -58,6 +58,9 @@ This example upgrades a search service application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the search service application to upgrade. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -115,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md index c6cc191a5..7dcd7bfe1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ``` C:\PS>$site= Get-SPSite https://test @@ -39,18 +39,19 @@ Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $site This example upgrades the search settings for the site collection referenced by $site. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the site collection for which to upgrade search settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPFarm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPFarm.md index ddd3d2db9..e55bc45f6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPFarm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPFarm.md @@ -15,7 +15,6 @@ ms.reviewer: ## SYNOPSIS Activates the Upgrade method for the local farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ``` Upgrade-SPFarm ``` @@ -40,6 +39,9 @@ This example starts the upgrade process on the local farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -69,7 +73,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -ServerOnly + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to only upgrade local server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -SkipDatabaseUpgrade + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to not upgrade databases and their child objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +137,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies to not upgrade all site objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPProfileServiceApplication.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPProfileServiceApplication.md index 6dc299c9c..3030efa11 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPProfileServiceApplication.md @@ -27,7 +27,7 @@ Upgrades User Profile Service and its related profile and social store. ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ``` $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} Upgrade-SPProfileServiceApplication $sa @@ -38,6 +38,9 @@ This example upgrades the specified user profile service application. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies the User Profile Service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user profile service application (for example, UserProfileServiceApp); or an instance of a valid SPServiceApplication object. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -95,7 +104,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSingleSignOnDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSingleSignOnDatabase.md index c9b4c6997..d0f5304d1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSingleSignOnDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSingleSignOnDatabase.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ``` Upgrade-SPSingleSignOnDatabase -SSOConnectionString "Data Source=oldServer;Database=SSO;Trusted_Connection=yes;" -SecureStoreConnectionString "Data Source=CONTOSO\SQLDatabase;Database=ContosoSSDatabase;Trusted_Connection=yes;" -SecureStorePassphrase "abcDEF123!@#" ``` @@ -42,13 +42,15 @@ This example migrates the SSO database at the SSO connection to a Secure Store d ## PARAMETERS ### -SecureStoreConnectionString + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server connection string for the Secure Store database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -SecureStorePassphrase + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the passphrase used for the Secure Store database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -SSOConnectionString + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SQL Server connection string for the SSO database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +110,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSite.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSite.md index fc2309594..0085fdfdb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSite.md @@ -38,14 +38,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE 1---------- +### EXAMPLE 1 ``` Upgrade-SPSite https:///sites/testsite ``` This example upgrades the existing https://\/sites/testsite site collection by using only available build-to-build upgrade actions that are associated with the current site collection operating mode. The SPSite.CompatibilityLevel will not be changed by this operation. -### -------------EXAMPLE 2---------- +### EXAMPLE 2 ``` Upgrade-SPSite https:///sites/testsite -VersionUpgrade ``` @@ -55,13 +55,15 @@ This example upgrades the existing https://\/sites/testsite site col ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies the SPSite object to run upgrade operations against. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 1 @@ -71,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +87,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -100,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -110,13 +116,15 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies whether to send mail on completion of the site collection upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +134,15 @@ Accept wildcard characters: False ``` ### -QueueOnly -Specifies to put the site into the queue for a delayed upgrade that is managed by a timer job. + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + +Specifies to put the site into the queue for a delayed upgrade that is managed by a timer job. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +152,15 @@ Accept wildcard characters: False ``` ### -Unthrottled + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies a farm administrator to bypass the throttle which permits a site collection to be upgraded even if there are "too many" site collections in the throttle to be upgraded. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +170,9 @@ Accept wildcard characters: False ``` ### -VersionUpgrade + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Specifies to perform a version-to-version upgrade on the SPSite object. When this parameter is set, it internally triggers all available build-to-build actions that are associated with the current site collection operating mode. Version-to-version actions follow to bring site collections to the next site collection operating mode inclusive of all new build-to-build actions that are associated with the new site collection operating mode. @@ -166,8 +181,7 @@ When this parameter is not set, it triggers only available build-to-build upgrad ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -184,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -194,6 +210,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Specifies what priority to upgrade the site. The valid values are: @@ -207,8 +226,7 @@ The valid values are: ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSiteMapDatabase.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSiteMapDatabase.md index 64c7c0c6d..fee2936de 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSiteMapDatabase.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Upgrade-SPSiteMapDatabase.md @@ -27,7 +27,7 @@ Do not use. ## EXAMPLES -### -------------EXAMPLE 1---------- +### EXAMPLE 1 ``` #Do not use ``` @@ -37,13 +37,15 @@ Do not use. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named @@ -69,13 +73,15 @@ Accept wildcard characters: False ``` ### -DatabaseId + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Do not use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2016, SharePoint Server 2019 +Aliases: Required: True Position: 0 @@ -85,6 +91,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server 2016, SharePoint Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -92,7 +101,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server 2016, SharePoint Server 2019 Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPAppDeniedEndpoint.md index 2b2288a8a..202a2d81b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPAppDeniedEndpoint.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPAppDeniedEndpoint.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a relative URL endpoint of a server to the list of app-denied endpoints. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Add-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" ``` @@ -40,14 +39,16 @@ Apps will not be able to access this endpoint. ## PARAMETERS ### -Endpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies a relative URL endpoint of a server that is added to the list of app-denied endpoints. Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPCertificateNotificationContact.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPCertificateNotificationContact.md index d0496bc93..165ed8423 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPCertificateNotificationContact.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPCertificateNotificationContact.md @@ -24,7 +24,7 @@ The \`Add-SPCertificateNotificationContact\` cmdlet adds an email address to the ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Add-SPCertificateNotificationContact -EmailAddress sharepoint-admins@example.com ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPClaimTypeMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPClaimTypeMapping.md index 2c3d0272a..949dcf0a6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPClaimTypeMapping.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a claim mapping to a trusted security token service (STS) identity provider. - ## SYNTAX ``` @@ -30,13 +29,13 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $trustedIdentityTokenIssuer = Get-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" -$trustedIdentityTokenIssuer.ClaimTypes.Add("http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier") +$trustedIdentityTokenIssuer.ClaimTypes.Add("http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier") -$trustedIdentityTokenIssuer.Update() +$trustedIdentityTokenIssuer.Update() $mapping = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" @@ -48,6 +47,9 @@ This example adds a claim mapping to a trusted identity token issuer. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the STS for the farm that will issue the security token for the identity provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, ClaimMap1); or an instance of a valid SPClaimMapping object. @@ -55,8 +57,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server Subscription Edition + Specifies the farm trust Token Issuer (STS authentication provider). The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef; or a valid name of an authentication provider (for example, MyIDprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. @@ -73,8 +77,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef; ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +101,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites the claim mapping rule if it exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDatabaseToAvailabilityGroup.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDatabaseToAvailabilityGroup.md index 411713b10..77c6ccfe6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDatabaseToAvailabilityGroup.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDatabaseToAvailabilityGroup.md @@ -31,16 +31,16 @@ Use the Add-SPDatabaseToAvailabilityGroup cmdlet to add an availability group to ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell -Add-SPDatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\ +Add-SPDatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\ ``` This example adds the database WSS_Content to the availability group named "MyAvailabilityGroup". -### ------------Example 2----------- +### Example 2 ```powershell -Add-SPDatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\ +Add-SPDatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\ ``` This example adds all SharePoint databases attached to the farm to the availability group named "MyAvailabilityGroup" @@ -48,13 +48,15 @@ This example adds all SharePoint databases attached to the farm to the availabil ## PARAMETERS ### -AGName + +> Applicable: SharePoint Server Subscription Edition + The name of the availability group from which the databases are being added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -64,15 +66,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,14 +86,16 @@ Accept wildcard characters: False ``` ### -DatabaseName -The name of the database to be added to the availability group. + +> Applicable: SharePoint Server Subscription Edition + +The name of the database to be added to the availability group. **Note:** This parameter should not be used in conjunction with the **ProcessAllDatabases** parameter. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,13 +105,15 @@ Accept wildcard characters: False ``` ### -FileShare + +> Applicable: SharePoint Server Subscription Edition + When a database is being added to the availability group, backup / restores are done from this location to propagate the database to all replicas. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,13 +123,15 @@ Accept wildcard characters: False ``` ### -ProcessAllDatabases + +> Applicable: SharePoint Server Subscription Edition + Adds all databases from the current SharePoint farm into the availability group. ```yaml Type: SwitchParameter Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDiagnosticsPerformanceCounter.md index 3b7cd9986..83a473d0f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDiagnosticsPerformanceCounter.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a new instance of a performance counter to a Web front end computer or a database server. - ## SYNTAX ### AddCounter @@ -47,17 +46,16 @@ The Add-SPDiagnosticsPerformanceCounter cmdlet adds a performance counter to a f A performance counter is read and recorded in the usage database. By default, the new performance counter is added to the database servers in the farm. - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Add-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" ``` This example adds the counter that has the name ASP.NET\Requests Queued on front end Web servers. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. Disk Queue Length" -allinstances ``` @@ -65,7 +63,7 @@ Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. Disk Q This example adds all instances of the counter PhysicalDisk in the category Avg. Disk Queue Length on front end Web servers. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Add-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver ``` @@ -75,6 +73,9 @@ This example adds the _Total instance of the counter % Processor Time in the cat ## PARAMETERS ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies the category of performance counter to add to the target Web front end computer or database server. The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. @@ -82,8 +83,7 @@ The type must be a valid name of a category of performance counters; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of counter to add to the target Web front end computer or database server. The type must be a valid name of counter type; for example, Requests Queued, Avg. @@ -100,9 +103,8 @@ Disk Queue Length, and % Processor Time. ```yaml Type: String -Parameter Sets: AddCounter -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: AddCounter, AddInstance +Aliases: Required: True Position: Named @@ -111,29 +113,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server Subscription Edition +### -Instance -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -Instance Specifies the display name of the new performance counter. The type must be a valid name of a performance counter instance; for example Total_PerfCounter. ```yaml Type: String -Parameter Sets: AddInstance -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: AddInstance, AddMultipleCounters +Aliases: Required: True Position: Named @@ -142,27 +133,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server Subscription Edition +### -AllInstances -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -AllInstances Collects all instances of a counter category and type on the target Web front end computer or database server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,6 +152,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -183,8 +166,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -201,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -211,13 +195,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Adds the specified performance counter to all database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,13 +213,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server Subscription Edition + Adds the specified performance counter to all Web front end computers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -250,7 +241,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -260,13 +250,15 @@ Accept wildcard characters: False ``` ### -CounterList + +> Applicable: SharePoint Server Subscription Edition + {{Fill CounterList Description}} ```yaml Type: String[] Parameter Sets: AddMultipleCounters -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDistributedCacheServiceInstance.md index e5eb0bad2..7288851a1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPDistributedCacheServiceInstance.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds an instance of the distributed cache service to a local server. - ## SYNTAX ### (Default) @@ -41,10 +40,9 @@ This cmdlet contains more than one parameter set. You may only use parameters fr Use the Add-SPDistributedCacheServiceInstance cmdlet to add an instance of the distributed cache server to a local server. This is required to start the AppFabric service. - ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Add-SPDistributedCacheServiceInstance ``` @@ -55,17 +53,17 @@ This example adds an instance of the distributed cache service to a local server ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +73,9 @@ Accept wildcard characters: False ``` ### -CacheSizeInMB + +> Applicable: SharePoint Server Subscription Edition + Specifies the amount of RAM to allocate for the Distributed Cache service instance. If this parameter is not specified, the default value will be used. @@ -82,8 +83,7 @@ If this parameter is not specified, the default value will be used. ```yaml Type: Int32 Parameter Sets: CacheSizeSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,7 +93,10 @@ Accept wildcard characters: False ``` ### -Role -Specifies the type of server role that the Distributed Cache service instance should be configured for. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the type of server role that the Distributed Cache service instance should be configured for. This parameter is typically used when you are going to do a server role conversion to the specified server role. @@ -106,9 +109,8 @@ The valid values are: ```yaml Type: SPServerRole Parameter Sets: LocalServerRoleSet -Aliases: +Aliases: Accepted values: DistributedCache, SingleServerFarm, WebFrontEndWithDistributedCache -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPInfoPathUserAgent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPInfoPathUserAgent.md index 5d411ad4a..e8b202484 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPInfoPathUserAgent.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------------- +### EXAMPLE ```powershell Add-SPInfoPathUserAgent -Name "NewAgent" ``` @@ -37,6 +37,9 @@ This example creates a new agent named NewAgent. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the user agent to receive InfoPath 2013 files. These user agents represent search bots that are commonly used in an enterprise environment. If a different search technology is being used and InfoPath 2013 files are not being indexed, you can add additional search bots for that technology to the collection. @@ -46,8 +49,7 @@ The type must be a valid file name; for example UserAgentName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerDistributionListSearchDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerDistributionListSearchDomain.md index 5ec4c7ec6..f217f93b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerDistributionListSearchDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerDistributionListSearchDomain.md @@ -25,7 +25,7 @@ This Add-SPPeoplePickerDistributionListSearchDomain cmdlet adds a domain to the ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Add-SPPeoplePickerDistributionListSearchDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -Index 2 ``` @@ -36,6 +36,9 @@ If the length of the list was less than 2 before the insert, an exception will b ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,7 +51,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + The domain name to add in the list. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Index + +> Applicable: SharePoint Server Subscription Edition + The position to insert the domain in the list begin from 0. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to modify the distribution list search domain list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -129,7 +142,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerSearchADDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerSearchADDomain.md index 624aa01ae..e74a2da73 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerSearchADDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerSearchADDomain.md @@ -25,14 +25,14 @@ This Add-SPPeoplePickerSearchADDomain cmdlet adds a forest or domain with domain ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Add-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -IsForest ``` This example adds forest corp.contoso.com to the People Picker search Active Directory domain list of the Web application MyOfficeApp1. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Add-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -Credential (New-Object System.Management.Automation.PSCredential "contoso\user", (ConvertTo-SecureString "password" -AsPlainText -Force)) ``` @@ -42,6 +42,9 @@ This example adds domain corp.contoso.com to the People Picker search Active Dir ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,7 +57,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server Subscription Edition + The login name and password used by People Picker for authenticating to a forest or domain that it doesn't have a two-way trust relationship with. This parameter is not neccessary if it has a two-way trust relationship with the forest or domain specified by the DomainName parameter. @@ -74,7 +79,6 @@ If this parameter is not specified, then no login name and password will be used Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + Name of the forest or domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -100,13 +106,15 @@ Accept wildcard characters: False ``` ### -Index + +> Applicable: SharePoint Server Subscription Edition + The position to insert the forest or domain in the list begin from 0. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,13 +124,15 @@ Accept wildcard characters: False ``` ### -IsForest + +> Applicable: SharePoint Server Subscription Edition + Whether the name specified by the DomainName parameter is an active directory forest or an Active Directory domain. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the newly added forest or domain should enable Secure LDAP (LDAPS). ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,13 +160,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to add the People Picker forest/domain search setting to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -164,13 +178,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -180,6 +196,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -187,7 +206,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerServiceAccountDirectoryPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerServiceAccountDirectoryPath.md index e85262665..eb561ba94 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerServiceAccountDirectoryPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPeoplePickerServiceAccountDirectoryPath.md @@ -27,7 +27,7 @@ This Add-SPPeoplePickerServiceAccountDirectoryPath cmdlet adds an OU into the se ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Add-SPPeoplePickerServiceAccountDirectoryPath -WebApplication http://MyOfficeApp1 -OUName "OU=FarmAdmin,DC=Contoso,DC=local" ``` @@ -37,6 +37,9 @@ This example adds OU "FarmAdmin" to the service account directory path list of W ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,7 +52,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -Index + +> Applicable: SharePoint Server Subscription Edition + The position to insert the domain in the list beginning with 0. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnitName + +> Applicable: SharePoint Server Subscription Edition + {{ Fill OrganizationalUnitName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -91,13 +97,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to modify the service account directory path list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -107,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -123,6 +133,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -130,7 +143,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPluggableSecurityTrimmer.md index 4093064d9..33f8ae405 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPPluggableSecurityTrimmer.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1-------------------- +### EXAMPLE 1 ```powershell $proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 @@ -38,6 +38,9 @@ This example adds a pluggable security trimmer that is related to the User Profi ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the User Profile service application proxy to which you are adding the pluggable security trimmer. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -45,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -PlugInId + +> Applicable: SharePoint Server Subscription Edition + The index of the pluggable security trimmer must have an integer value greater than or equal to zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -QualifiedTypeName + +> Applicable: SharePoint Server Subscription Edition + Specifies the qualified type name of the class that implements the pluggable security trimmer. The type must be a valid qualified type name, in the form Microsoft.Office.Server.SocialData.SocialSecurityTrimmer,Microsoft.Office.Server.UserProfiles,Version=14.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c. @@ -118,8 +129,7 @@ The type must be a valid qualified type name, in the form Microsoft.Office.Serve ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,13 +158,15 @@ Accept wildcard characters: False ``` ### -CustomProperties + +> Applicable: SharePoint Server Subscription Edition + {{Fill CustomProperties Description}} ```yaml Type: NameValueCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileLeader.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileLeader.md index 900f88bdd..00b2d750e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileLeader.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileLeader.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------EXAMPLE------------ +### EXAMPLE ```powershell $upaProxy = Get-SPServiceApplicationProxy | where {$_.TypeName -eq 'User Profile Service Application Proxy'} Add-SPProfileLeader -ProfileServiceApplicationProxy $upaProxy -Name "contoso\janedoe" @@ -44,13 +44,15 @@ This example adds a company leader named Jane Doe. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,14 +62,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name to be added as a leader for the new User Profile Service application. For example, contoso\janedoe. ```yaml Type: SPProfileLeaderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,14 +124,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileSyncConnection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileSyncConnection.md index 616458880..98b28d997 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileSyncConnection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPProfileSyncConnection.md @@ -38,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE----------- +### EXAMPLE ```powershell Add-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionForestName "fabrikam.com"-ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" ``` @@ -48,13 +48,15 @@ This example adds a user from the fabrikam domain using a specific user profile ## PARAMETERS ### -ProfileServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile service application. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -ConnectionDomain + +> Applicable: SharePoint Server Subscription Edition + Specifies the NetBIOS name of the domain you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ``` ### -ConnectionForestName + +> Applicable: SharePoint Server Subscription Edition + Specifies the fully qualified domain name (FQDN) of the forest you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,13 +102,15 @@ Accept wildcard characters: False ``` ### -ConnectionPassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the account used for directory connection. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -112,14 +120,16 @@ Accept wildcard characters: False ``` ### -ConnectionSynchronizationOU + +> Applicable: SharePoint Server Subscription Edition + Specifies the top level organizational unit (OU) that you would like to synchronize. The value must be a domain name and you can only include one container per command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -129,13 +139,15 @@ Accept wildcard characters: False ``` ### -ConnectionUserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to be used for the synchronization connection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -145,6 +157,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -156,8 +171,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,6 +181,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -174,7 +191,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -184,13 +200,15 @@ Accept wildcard characters: False ``` ### -ConnectionClaimIDMapAttribute + +> Applicable: SharePoint Server Subscription Edition + Specifies the Claims ID used by the Claim Provider, that is, samAccountName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,13 +218,15 @@ Accept wildcard characters: False ``` ### -ConnectionClaimProviderIdValue + +> Applicable: SharePoint Server Subscription Edition + Specifies the Claims Provider ID or Name for an authentication type while a Web App is configured. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,6 +236,9 @@ Accept wildcard characters: False ``` ### -ConnectionClaimProviderTypeValue + +> Applicable: SharePoint Server Subscription Edition + Specifies the Authentication claim Provider that will be used to encode the User Profile accounts names. For example, Windows/Forms etc. This means if a user logs in using the given Authentication Type, then a profile can be found by looking up a claim encoded credentials. @@ -223,8 +246,7 @@ This means if a user logs in using the given Authentication Type, then a profile ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -234,13 +256,15 @@ Accept wildcard characters: False ``` ### -ConnectionNamingContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the naming context of the directory information tree to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -250,14 +274,16 @@ Accept wildcard characters: False ``` ### -ConnectionPort + +> Applicable: SharePoint Server Subscription Edition + Specifies the port to be used to connect to the directory service. The default port is 389. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -267,13 +293,15 @@ Accept wildcard characters: False ``` ### -ConnectionServerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the domain controller to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -283,6 +311,9 @@ Accept wildcard characters: False ``` ### -ConnectionUseSSL + +> Applicable: SharePoint Server Subscription Edition + Specifies if the connection to the directory service must be over SSL. The valid values are: $True or $False @@ -290,8 +321,7 @@ The valid values are: $True or $False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -301,6 +331,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -308,7 +341,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -318,13 +350,15 @@ Accept wildcard characters: False ``` ### -ConnectionFilterOutUnlicensed + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -334,16 +368,18 @@ Accept wildcard characters: False ``` ### -ConnectionUseDisabledFilter + +> Applicable: SharePoint Server Subscription Edition + Filters out disabled accounts. ->[!NOTE] +>[!NOTE] This will only filter out accounts which are in a disabled state prior to being imported. It will not filter out accounts which have been disabled after importing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachineInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachineInfo.md index eb04f9a66..d1df8f212 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachineInfo.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a new routing target to the farm. - ## SYNTAX ``` @@ -29,7 +28,7 @@ Use the Add-SPRoutingMachineInfo cmdlet to add a new routing target to the farm ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -41,13 +40,15 @@ This example adds a routing target for a specified identity to the farm. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to add to the routing target. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,13 +58,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the computer to add to the route. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not the added computer will be available for routing. The valid values are: @@ -105,8 +113,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -OutgoingPort + +> Applicable: SharePoint Server Subscription Edition + Specifies the port used by Request Manager to make an outgoing connection. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +141,9 @@ Accept wildcard characters: False ``` ### -OutgoingScheme + +> Applicable: SharePoint Server Subscription Edition + Determines the Http scheme of outgoing connections. The valid values are: @@ -143,8 +155,7 @@ The valid values are: ```yaml Type: SPRoutingOutgoingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,14 +165,16 @@ Accept wildcard characters: False ``` ### -StaticWeight + +> Applicable: SharePoint Server Subscription Edition + Specifies the static weight of a computer routing that is used by Request Manager. If the static weight is higher, more requests will be routed to the computer. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachinePool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachinePool.md index 96d8258ac..089040e06 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingMachinePool.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a new machine pool. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -42,13 +41,15 @@ This example adds a machine pool. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to add to the routing machine pool. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of machine pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -MachineTargets + +> Applicable: SharePoint Server Subscription Edition + Specifies the routing targets collection that the machine pool will contain. ```yaml Type: SPRoutingRuleTargetPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingRule.md index 85a3d2914..5c0382758 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPRoutingRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a routing rule. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------- +### EXAMPLE ```powershell $rm=Get-SPRequestManagementSettings -Identity $web Get-SPRoutingRule -RequestManagementSettings $rm @@ -44,13 +43,15 @@ This examples adds a routing rule to the farm by using the $rm and $machines var ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to add to the routing rule. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,13 +61,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,13 +103,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server Subscription Edition + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -ExecutionGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the group in which the rule will be placed. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,13 +157,15 @@ Accept wildcard characters: False ``` ### -MachinePool + +> Applicable: SharePoint Server Subscription Edition + Specifies the pool of machines to which a request will be routed if the created rule is matched. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPScaleOutDatabase.md index e6f11bfe8..bdba9129f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPScaleOutDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds an existing scale-out database to the specified service application. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Add-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -42,13 +41,15 @@ This example adds a new or existing scale out database into a specific service a ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to add to the specified service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the owner's credentials of the scale-out database to be added to the service application. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,13 +138,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server Subscription Edition + The name of the failover server for the scale-out database to be added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,14 +156,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + The name of the server hosting the scale-out database to be added. If a value is not provided, the default database server will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -169,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + {{Fill DeferUpgradeActions Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSecureStoreSystemAccount.md index f5519e4d0..050bdebac 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSecureStoreSystemAccount.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE---------- +### EXAMPLE ```powershell Add-SPSecureStoreSystemAccount -AccountName contoso\jdoe ``` @@ -36,13 +36,15 @@ This example adds the account name jdoe. ## PARAMETERS ### -AccountName + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -63,8 +68,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -81,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServerScaleOutDatabase.md index aacfcba00..92a7f912e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServerScaleOutDatabase.md @@ -13,7 +13,6 @@ schema: 2.0.0 Adds an existing scale-out content database to the specified service application. - ## SYNTAX ``` @@ -29,7 +28,7 @@ Use the Add-SPServerScaleOutDatabase cmdlet to add an existing scale-out databas ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Add-SPServerScaleOutDatabase -ServiceApplication $serviceApplication @@ -37,18 +36,18 @@ Add-SPServerScaleOutDatabase -ServiceApplication $serviceApplication This example adds a new or existing scale out database into a specific service application. - ## PARAMETERS ### -DatabaseName +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to add to the specified service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +58,14 @@ Accept wildcard characters: False ### -ServiceApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +76,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +89,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +100,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -117,13 +119,14 @@ Accept wildcard characters: False ### -DatabaseCredentials +> Applicable: SharePoint Server Subscription Edition + Specifies the owner's credentials of the scale-out database to be added to the service application. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,13 +137,14 @@ Accept wildcard characters: False ### -DatabaseFailoverServer +> Applicable: SharePoint Server Subscription Edition + The name of the failover server for the scale-out database to be added. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,14 +155,15 @@ Accept wildcard characters: False ### -DatabaseServer +> Applicable: SharePoint Server Subscription Edition + The name of the server hosting the scale-out database to be added. If a value is not provided, the default database server will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +174,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +183,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -186,13 +192,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions -Specifies whether upgrade actions are deferred duringi an Upgrade process. + +> Applicable: SharePoint Server Subscription Edition + +Specifies whether upgrade actions are deferred duringi an Upgrade process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServiceApplicationProxyGroupMember.md index b1134569a..62a03273c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServiceApplicationProxyGroupMember.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPServiceApplicationProxyGroupMember.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a member to the service application proxy group. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -match 'User Profile Service Application Proxy'} Add-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member $proxy @@ -45,13 +44,15 @@ Use this result for any other SPServiceApplicationProxyGroup cmdlets. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application proxy group to which to add the member. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: SharePoint Server Subscription Edition + Specifies an array of members to add to the service application proxy group. ```yaml Type: SPServiceApplicationProxyPipeBind[] Parameter Sets: (All) Aliases: Proxy -Applicable: SharePoint Server Subscription Edition Required: True Position: 2 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPShellAdmin.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPShellAdmin.md index 647dfe6b2..cec392b30 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPShellAdmin.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPShellAdmin.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a user to the SharePoint_Shell_Access role for the specified database. - ## SYNTAX ``` @@ -47,28 +46,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1------------------------- +### EXAMPLE 1 ```powershell Add-SPShellAdmin -UserName CONTOSO\User1 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in the farm configuration database only, and also ensures the user is added to the WSS_Admin_WPG local group on each server in the farm. -### -------------------EXAMPLE 2------------------------- +### EXAMPLE 2 ```powershell Add-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified content database and the configuration database by passing a database GUID to the cmdlet. -### -------------------EXAMPLE 3------------------------- +### EXAMPLE 3 ```powershell Get-SPDatabase | Where-Object {$_.WebApplication -like "SPAdministrationWebApplication"} | Add-SPShellAdmin CONTOSO\User1 ``` This example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified Central Administration content database and the configuration database. -### -------------------EXAMPLE 4------------------------- +### EXAMPLE 4 ```powershell Get-SPDatabase | ?{$_.Name -eq "WSS_Content"} | Add-SPShellAdmin -Username CONTOSO\User1 ``` @@ -78,13 +77,15 @@ This example adds a new user named User1 to the SharePoint_Shell_Access role of ## PARAMETERS ### -UserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the user to add to the SharePoint_Shell_Access role in the target database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the database or the Database object that includes the SharePoint_Shell_Access role to which you want to add the user. If the database parameter is not specified, the configuration database is used. The farm configuration database is always included, even if you specify another database. @@ -140,8 +148,7 @@ The farm configuration database is always included, even if you specify another ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +168,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionFeaturePackMember.md index 4bba7b932..fe183b689 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionFeaturePackMember.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionFeaturePackMember.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a feature to a SharePoint Feature set. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------------- +### EXAMPLE ```powershell $fp = New-SPSiteSubscriptionFeaturePack Get-SPFeature -limit all | Where{ $_.Scope -eq "WEB" } | Add-SPSiteSubscriptionFeaturePackMember -id $fp @@ -47,6 +46,9 @@ The Feature set is refreshed in the last line so that the local object has the c ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Feature set object or GUID to which the given SharePoint Feature is added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a Feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -54,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -65,13 +66,15 @@ Accept wildcard characters: False ``` ### -FeatureDefinition + +> Applicable: SharePoint Server Subscription Edition + Specifies the Feature definition, name, or GUID to add to the Feature set. ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -110,7 +118,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,6 +127,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionProfileConfig.md index de80e1ff8..d73bf0eb5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSiteSubscriptionProfileConfig.md @@ -41,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ```powershell $sub = Get-SPSiteSubscription https://contoso/my $proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} @@ -54,6 +54,9 @@ This example creates a new User Profile Service application tenant. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application to add the site subscription to. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -61,8 +64,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -72,15 +74,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the My Site host for the site subscription is provisioned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -89,27 +93,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +### -ProfileServiceApplicationProxy -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -ProfileServiceApplicationProxy Specifies the identifier for the User Profile Service Application proxy where the tenant is to be created. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -119,6 +112,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +126,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +136,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -158,6 +155,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -165,8 +165,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,6 +175,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -194,8 +196,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,6 +206,9 @@ Accept wildcard characters: False ``` ### -SynchronizationOU + +> Applicable: SharePoint Server Subscription Edition + Specifies the organizational unit serving the site subscription. The type must be a valid name of an organizational unit; for example, OrgUnit1. @@ -212,8 +216,7 @@ The type must be a valid name of an organizational unit; for example, OrgUnit1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -223,6 +226,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -230,7 +236,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSolution.md index 65e7bb960..2234d9d12 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPSolution.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Add-SPSolution -LiteralPath c:\contoso_solution.wsp ``` @@ -39,6 +39,9 @@ This example adds the SharePoint solution in the file contoso_solution.wsp to th ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path to the solution package. The type must be a valid path in either of the following forms: @@ -49,8 +52,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the language pack to install with the solution package. The type must be a valid language identifier; for example, 1033. @@ -106,8 +115,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPThrottlingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPThrottlingRule.md index 465c972d3..8def8f078 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPThrottlingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPThrottlingRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a new throttling rule. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -43,13 +42,15 @@ This example adds a throttling rule for a specified identity by using the $rm an ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to add. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the throttling rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server Subscription Edition + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,14 +138,16 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server Subscription Edition + Specifies a value between 0 and 10 which defines the maximum threshold for throttling. The Request Manager will remove routing targets if their Health-Score becomes greater than this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserLicenseMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserLicenseMapping.md index 147e81092..1d62f5df4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserLicenseMapping.md @@ -14,7 +14,6 @@ schema: 2.0.0 Maps a security group, forms-based role, or claim to a SharePoint user license. - ## SYNTAX ``` @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1------------------- +### EXAMPLE 1 ```powershell $a = New-SPUserLicenseMapping -SecurityGroup yoursecuritygroup -License Enterprise Add-SPUserLicenseMapping -Mapping $a @@ -47,11 +46,13 @@ This example adds user mappings for the entire farm. ## PARAMETERS ### -Mapping + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserSolution.md index 300e60ca0..b805dadad 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Add-SPUserSolution.md @@ -14,7 +14,6 @@ schema: 2.0.0 Uploads a new sandboxed solution to the solution gallery. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Add-SPUserSolution -LiteralPath c:\contoso_solution.wsp -Site https://sitename ``` @@ -40,6 +39,9 @@ This example adds the sandboxed solution c:\contoso_solution.wsp to the site htt ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path to the sandboxed solution package. The type must be a valid path in either of the following forms: @@ -50,8 +52,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the sandboxed solution is to be added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSiteobject. @@ -68,8 +72,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPConfigurationDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPConfigurationDatabase.md index 6f162e15d..bf256a59c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPConfigurationDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Performs a farm-level configuration-only backup. - ## SYNTAX ### DefaultSet @@ -46,14 +45,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1-------------------- +### EXAMPLE 1 ```powershell Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -ShowTree ``` This example displays components that are available for inclusion in a configuration-only backup. -### -------------------EXAMPLE 2-------------------- +### EXAMPLE 2 ```powershell Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -Verbose ``` @@ -63,6 +62,9 @@ This example performs a configuration-only backup with verbose output. ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server Subscription Edition + Specifies the path where SharePoint Products stores the backup package it generates. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -81,8 +83,7 @@ The spbr* folders are automatically created. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -92,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +107,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +117,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID and password that corresponds to the administrator user name for the SQL Server database. This parameter should only be specified if SQL authentication is used to connect to the database. @@ -122,8 +128,7 @@ If Windows authentication is used to connect to the database, then this paramete ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the configuration database name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +156,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL database server that contains the configuration database. The default value is the local computer name. @@ -157,8 +167,7 @@ The type must be a valid database server; for example, DS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server Subscription Edition + Indicates the part of the farm to back up. You may use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items match the name, the full path must be provided. @@ -178,8 +190,7 @@ If the Item parameter is not specified, the entire farm configuration is backed ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -189,6 +200,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server Subscription Edition + Displays which objects in the farm will be backed up based on the other parameters passed to the backup cmdlet, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPConfigurationDatabase cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets (\[ \]). @@ -197,8 +211,7 @@ A backup will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPEnterpriseSearchServiceApplicationIndex.md index b6bd059eb..0eb755aae 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPEnterpriseSearchServiceApplicationIndex.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPEnterpriseSearchServiceApplicationIndex.md @@ -31,27 +31,26 @@ Backup-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] Applicable: SharePoint Server Subscription Edition + Specifies the phase of the backup job. ```yaml Type: Int32 Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -87,13 +88,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Name of the search service application to be backed up ```yaml Type: SearchServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -103,13 +106,15 @@ Accept wildcard characters: False ``` ### -BackupFolder + +> Applicable: SharePoint Server Subscription Edition + Full UNC path of the backup files should be written. ```yaml Type: String Parameter Sets: RunBackup -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -BackupHandleFile + +> Applicable: SharePoint Server Subscription Edition + Specifies a file handle for an ongoing backup job. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 4 @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -Retries + +> Applicable: SharePoint Server Subscription Edition + Number of times to retry if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 5 @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -162,8 +174,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -180,7 +194,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -190,6 +203,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -197,7 +213,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -207,13 +222,15 @@ Accept wildcard characters: False ``` ### -Abort + +> Applicable: SharePoint Server Subscription Edition + {{Fill Abort Description}} ```yaml Type: SwitchParameter Parameter Sets: AbortBackup -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -223,13 +240,15 @@ Accept wildcard characters: False ``` ### -PeerToPeer + +> Applicable: SharePoint Server Subscription Edition + {{Fill PeerToPeer Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -239,13 +258,15 @@ Accept wildcard characters: False ``` ### -SpecifiedBackupHandle + +> Applicable: SharePoint Server Subscription Edition + {{Fill SpecifiedBackupHandle Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPFarm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPFarm.md index 66fcf58da..b45eedcde 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPFarm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPFarm.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a backup of an individual database, Web application, or the entire farm. - ## SYNTAX ### DefaultSet @@ -45,28 +44,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Backup-SPFarm -Directory \\file_server\share\Backup -BackupMethod full -ConfigurationOnly ``` This example backs up the configuration settings of the farm to the \\\\file_server\share\Backup directory. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Backup-SPFarm -ShowTree -Item "Microsoft SharePoint Foundation Web Application" -Verbose ``` This example shows which components of the farm would be backed up under the "Microsoft SharePoint Foundation Web Application" node, but do not actually back them up. -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Backup-SPFarm -Directory C:\Backup -BackupMethod full -BackupThreads 10 -Force ``` This example performs a backup of a farm using 10 threads and forces the backup to be saved to the C:\Backup directory even though SharePoint estimates that it does not have sufficient space available. -### --------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ```powershell Backup-SPFarm -ShowTree ``` @@ -76,6 +75,9 @@ This example shows you the available objects to backup with `Backup-SPFarm`. ## PARAMETERS ### -BackupMethod + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of backup file to be created. If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used. @@ -92,8 +94,7 @@ The type must be either of the following: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -103,6 +104,9 @@ Accept wildcard characters: False ``` ### -Directory + +> Applicable: SharePoint Server Subscription Edition + Specifies the path where SharePoint Products stores the backup package it generates. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -121,8 +125,7 @@ The spbr* folders are automatically created. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -132,6 +135,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server Subscription Edition + Displays which objects in the farm will be backed up based on the other parameters passed to the Backup-SPFarm cmdelt, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPFarm cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets (\[ \]). @@ -140,8 +146,7 @@ A backup will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -151,6 +156,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -162,8 +170,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,6 +180,9 @@ Accept wildcard characters: False ``` ### -BackupThreads + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of threads to be used during the backup. The fewer the threads, the easier the backup log file is to read and understand. The more the threads, the more components that can be backed up in parallet, potentially resulting in a faster backup operation. @@ -185,8 +195,7 @@ If a backup is performed with the -ShowTree parameter, then the BackupMethod par ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -196,13 +205,15 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: SharePoint Server Subscription Edition + If set, the backup will contain configuration settings only (no data) for each of the objects to be backed up. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -212,6 +223,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specifies to proceed with a backup operation even if the estimation is that the backup directory does not have sufficient space to hold the entire backup. If a backup is performed with the ShowTree parameter, then the Force parameter is not used. @@ -219,8 +233,7 @@ If a backup is performed with the ShowTree parameter, then the Force parameter i ```yaml Type: SwitchParameter Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -230,6 +243,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server Subscription Edition + Indicates the part of the farm to back up. You might use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items are included in the same match, the full path must be provided. @@ -242,8 +258,7 @@ The type must be a valid item; for example, Farm\Microsoft SharePoint Foundation ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -253,6 +268,9 @@ Accept wildcard characters: False ``` ### -Percentage + +> Applicable: SharePoint Server Subscription Edition + Requests progress updates about the backup operation to be displayed in increments of that percentage; for example, a value of 5 displays backup progress updates at every 5 percent completed, and a value of 10 displays backup progress updates at every 10 percent completed. To have progress outputs displayed, you must specify the Verbose parameter. @@ -269,8 +287,7 @@ Valid values are an integer value between 1 and 100. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -280,6 +297,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -287,7 +307,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -297,13 +316,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPSite.md index 227805868..981828e3d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Backup-SPSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Performs a backup of a site collection. - ## SYNTAX ``` @@ -32,15 +31,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1-------------------- +### EXAMPLE 1 ```powershell Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak ``` This example backs up a site collection at https://server_name/sites/site_name to the C:\Backup\site_name.bak file. - -### -------------------EXAMPLE 2-------------------- +### EXAMPLE 2 ```powershell Get-SPSiteAdministration https://server_name/sites/site_name | Backup-SPSite -Path C:\Backup\site_name.bak ``` @@ -48,14 +46,14 @@ Get-SPSiteAdministration https://server_name/sites/site_name | Backup-SPSite -Pa This example backs up a site collection at https://server_name/sites/site_name to the C:\Backup\site_name.bak file. Same result as Example 1, but a different way of performing the operation. -### -------------------EXAMPLE 3-------------------- +### EXAMPLE 3 ```powershell Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -UseSqlSnapshot ``` This example backs up a site collection using database snapshots to ensure backup integrity. -### -------------------EXAMPLE 4-------------------- +### EXAMPLE 4 ```powershell Backup-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -NoSiteLock ``` @@ -65,6 +63,9 @@ This example backs up a site collection and prevents placing the site into a rea ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to be backed up. For example, a valid URL, such as https://server_name/sites/site_name or a GUID such as, "01234567-89ab-cdef-0123-456789abcdef" @@ -72,8 +73,7 @@ For example, a valid URL, such as https://server_name/sites/site_name or a GUID ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -83,13 +83,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the full path to the backup file (that is, C:\Backup\site_name.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +115,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,13 +144,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specify to overwrite an existing backup file if it already exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,6 +162,9 @@ Accept wildcard characters: False ``` ### -NoSiteLock + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection to remain read and write during the backup. If the NoSiteLock parameter is not specified, then a site collection that has a site collection lock setting of "none" or "no additions" will be temporarily set to "read only" while the site collection backup is performed. @@ -165,8 +176,7 @@ If users are writing to the site collection while the site collection is being b ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,6 +186,9 @@ Accept wildcard characters: False ``` ### -UseSqlSnapshot + +> Applicable: SharePoint Server Subscription Edition + Specifies a SQL Database Snapshot will be created when the backup begins, and all site collection data will be retrieved directly from the database snapshot. This snapshot will be deleted automatically when the backup completes @@ -186,8 +199,7 @@ It is not necessary to specify the NoSiteLock parameter when specifying the UseS ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,6 +209,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -204,7 +219,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -214,13 +228,15 @@ Accept wildcard characters: False ``` ### -UseABSDocStreamInfo + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPAppDeniedEndpointList.md index 78a3b2c58..a7549ca40 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPAppDeniedEndpointList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPAppDeniedEndpointList.md @@ -27,21 +27,21 @@ Use the Clear-SPAppDeniedEndpoint cmdlet to remove all app-denied endpoints in t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ```powershell Clear-SPAppDeniedEndpoint ``` This example removes all app-denied endpoints from the farm. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,12 +52,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,17 +66,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -89,18 +87,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPBusinessDataCatalogEntityNotificationWeb.md index 638079d98..593cee1d9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPBusinessDataCatalogEntityNotificationWeb.md @@ -14,7 +14,6 @@ schema: 2.0.0 Clears the entity notification site. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ```powershell Clear-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso" ``` @@ -39,13 +38,15 @@ This example clears the entity notification site for the service context corresp ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the dervice context for which the entity notification web has to be cleared. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPCertificateNotificationContact.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPCertificateNotificationContact.md index f0dfa9cec..d38e9b096 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPCertificateNotificationContact.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPCertificateNotificationContact.md @@ -24,7 +24,7 @@ The \`Clear-SPCertificateNotificationContact\` cmdlet deletes all email addresse ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Clear-SPCertificateNotificationContact ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPContentDatabaseSyncData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPContentDatabaseSyncData.md index 65db59f70..d6cff1ed7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPContentDatabaseSyncData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPContentDatabaseSyncData.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/clear-spcontentdatabasesyncdata -Applicable: SharePoint Server Subscription Edition + title: Clear-SPContentDatabaseSyncData schema: 2.0.0 --- @@ -24,7 +24,7 @@ Use the **Clear-SPContentDatabaseSyncData** to clear synchronization information ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Clear-SPContentDatabaseSyncData -DaysSinceLastProfileSync 12 ``` @@ -34,6 +34,9 @@ This example resets synchronization information from the content databases that ## PARAMETERS ### -DaysSinceLastProfileSync + +> Applicable: SharePoint Server Subscription Edition + Specifies the least number of days by which the databases are old. The default value of this parameter is 0. @@ -42,7 +45,7 @@ The default value of this parameter is 0. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: 1 Default value: None @@ -51,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -63,7 +69,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -72,13 +78,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -87,6 +96,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -94,7 +106,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPDistributedCacheItem.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPDistributedCacheItem.md index e56841120..68699e353 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPDistributedCacheItem.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPDistributedCacheItem.md @@ -14,7 +14,6 @@ schema: 2.0.0 Clears cached items from the distributed cache server. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------ +### EXAMPLE ```powershell Clear-SPDistributedCacheItem -ContainerType DistributedLogonTokenCache ``` @@ -40,6 +39,8 @@ This example removes all the cache items for distributed token cache. ### -ContainerType +> Applicable: SharePoint Server Subscription Edition + Specifies the container type to clear. The valid values for SharePoint Server 2013 and SharePoint Server 2016 are the following: @@ -51,12 +52,10 @@ Additional valid values for SharePoint Server 2016 are the following: DistributedSharedWithUserCache, DistributedUnifiedGroupsCache, DistributedFileLockThrottlerCache, DistributedResourceTallyCache, DistributedHealthScoreCache, DistributedClientSideAppUpdateTimeCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +99,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPLogLevel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPLogLevel.md index 629aa243d..7f14e5cb0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPLogLevel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPLogLevel.md @@ -14,7 +14,6 @@ schema: 2.0.0 Resets the Windows event logging and trace logging to their default values. - ## SYNTAX ``` @@ -30,28 +29,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Clear-SPLogLevel -Identity Cat1 ``` This example resets the log levels for a single category. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell "Cat1", "Cat2", "Cat3" | Clear-SPLogLevel ``` This example resets the log levels for multiple categories. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Get-SPLogLevel | Clear-SPLogLevel ``` This example resets the log levels for all categories. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Clear-SPLogLevel -Identity "SharePoint Server:Database" ``` @@ -61,6 +60,9 @@ This example resets the log level for the specific category in the SharePoint Se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event throttling setting is applied to all categories in the farm. @@ -91,8 +95,7 @@ Providing an invalid category is a non-terminating error and will be ignored. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server Subscription Edition + Specifies the result of the InputObject parameter to be piped. The value can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, modify their values, and then pipe the results to the Set-SPLogLevel cmdlet. @@ -109,8 +115,7 @@ The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, mod ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPMetadataWebServicePartitionData.md index 86b531024..07be1df23 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPMetadataWebServicePartitionData.md @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ```powershell Clear-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` @@ -45,6 +45,9 @@ This example removes data for a site subscription on a Metadata Service applicat ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription configuration to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -52,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the service proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -70,8 +75,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,13 +109,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -119,13 +127,15 @@ Accept wildcard characters: False ``` ### -FromContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,13 +145,15 @@ Accept wildcard characters: False ``` ### -FromServiceDatabase + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerDistributionListSearchDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerDistributionListSearchDomain.md index 9b14a86cb..8e8215a16 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerDistributionListSearchDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerDistributionListSearchDomain.md @@ -25,7 +25,7 @@ This Clear-SPPeoplePickerDistributionListSearchDomain cmdlet clears the distribu ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Clear-SPPeoplePickerDistributionListSearchDomain -WebApplication http://MyOfficeApp1 ``` @@ -35,6 +35,9 @@ This example clears the distribution list search domain list of Web application ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to clear the distribution list search domain list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -80,7 +87,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -97,7 +106,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerSearchADDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerSearchADDomain.md index b71640095..987c12cc7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerSearchADDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerSearchADDomain.md @@ -24,7 +24,7 @@ This Clear-PeoplePickerSearchADDomain cmdlet clears the list of forests and doma ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Clear-SPPeoplePickerSearchAdDomain -WebApplication http://MyOfficeApp1 ``` @@ -34,6 +34,9 @@ This example clears the list of People Picker search forests and domains of the ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to clear the search forests and domains from. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -79,7 +86,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -89,6 +95,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -96,7 +105,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerServiceAccountDirectoryPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerServiceAccountDirectoryPath.md index 981d96c21..00f8f6efa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerServiceAccountDirectoryPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPPeoplePickerServiceAccountDirectoryPath.md @@ -26,7 +26,7 @@ This Clear-SPPeoplePickerServiceAccountDirectoryPath cmdlet clears the OUs of th ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Clear-SPPeoplePickerServiceAccountDirectoryPath -WebApplication http://MyOfficeApp1 ``` @@ -36,6 +36,9 @@ This example clears OUs of the service account directory path list of Web applic ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,7 +51,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to clear the service account directory path list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -81,7 +88,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -98,7 +107,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseDeletedDataSubRange.md index 26307af9e..80cfa92c5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseDeletedDataSubRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseDeletedDataSubRange.md @@ -14,7 +14,6 @@ schema: 2.0.0 Clears all partitions inside the specified deleted subrange. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -46,13 +45,15 @@ The example then clears that subrange and all data in the partitions in the subr ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to clear the deleted subrange from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,13 +81,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server Subscription Edition + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseLog.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseLog.md index b4396e2e3..e2de9014b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseLog.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseLog.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -39,13 +39,15 @@ This example removes all scale-out log entries in the first scale-out database o ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database from which to clear the logs. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,14 +100,16 @@ Accept wildcard characters: False ``` ### -LogEntryTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time-out value in minutes for the log entries. If there is at least one log entry which is more recent than this value, no log entries will be deleted. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseTenantData.md index c4ab7f17e..11f2b3cf6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPScaleOutDatabaseTenantData.md @@ -14,7 +14,6 @@ schema: 2.0.0 Removes all data related to the specified site subscription. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ```powershell Clear-SPScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -40,13 +39,15 @@ This example clears all data related to the site subscription with id 5CAF2F99-A ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application in which to clear data. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +57,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription id of the site subscription in which to clear data. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +89,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreCredentialMapping.md index aba7fcedf..db3925746 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreCredentialMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreCredentialMapping.md @@ -37,7 +37,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" $userClaim = New-SPClaimsPrincipal -Identity "CONTOSO\janedoe" -IdentityType WindowsSamAccountName @@ -49,13 +49,15 @@ This example deletes the credential mapping from the target application ContosoT ## PARAMETERS ### -All + +> Applicable: SharePoint Server Subscription Edition + Specifies that the principal is deleted from all Secure Store applications. ```yaml Type: SwitchParameter Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: OneApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPClaims object that contains the principal. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for which the credential mapping will be deleted. ```yaml Type: SPServiceContextPipeBind Parameter Sets: AllApplications -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +135,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +145,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -152,6 +164,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +174,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreDefaultProvider.md index ed688cf92..bd8a0cfae 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreDefaultProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSecureStoreDefaultProvider.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Clear-SPSecureStoreDefaultProvider ``` @@ -35,6 +35,9 @@ This example clears the secure store provider. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,8 +49,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md index 20ccaafe6..52d1ded1a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseDeletedDataSubRange.md @@ -13,7 +13,6 @@ schema: 2.0.0 Clears all partitions inside the specified deleted subrange. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database Use the Clear-SPServerScaleOutDatabaseDeletedDataSubRange cmdlet to clear all partitions inside the specified deleted subrange that are contained within a specified scale-out database. - ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -43,18 +41,18 @@ Clear-SPServerScaleOutDatabaseDeletedDataSubRange -Database $database -Range $st This example creates a deleted subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. The example then clears that subrange and all data in the partitions in the subrange. - ## PARAMETERS ### -Database +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to clear the deleted subrange from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -65,13 +63,14 @@ Accept wildcard characters: False ### -IsUpperSubRange +> Applicable: SharePoint Server Subscription Edition + Specifies whether the subrange with deleted mode is on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,13 +81,14 @@ Accept wildcard characters: False ### -Range +> Applicable: SharePoint Server Subscription Edition + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +99,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +112,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +123,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -140,6 +142,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseLog.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseLog.md index 1857fc516..d9590daad 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseLog.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseLog.md @@ -13,7 +13,6 @@ schema: 2.0.0 Clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. - ## SYNTAX ``` @@ -28,7 +27,7 @@ Use the Clear-SPServerScaleOutDatabaseLog cmdlet clears all scale-out logs in th ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -37,18 +36,18 @@ Clear-SPServerScaleOutDatabaseLog -Database $database -LogEntryTimeout 30 This example removes all scale-out log entries in the first scale-out database of the specified service application unless there is a scale-out log entry which is more recent than 30 minutes. - ## PARAMETERS ### -Database +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database from which to clear the logs. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +58,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +82,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,14 +101,15 @@ Accept wildcard characters: False ### -LogEntryTimeout +> Applicable: SharePoint Server Subscription Edition + Specifies the time-out value in minutes for the log entries. If there is at least one log entry which is more recent than this value, no log entries will be deleted. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +120,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseTenantData.md index b5b4445bd..281c4a6bf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPServerScaleOutDatabaseTenantData.md @@ -27,10 +27,9 @@ Use the Clear-SPServerScaleOutDatabaseTenantData cmdlet removes all data related - ## EXAMPLES -### ------------EXAMPLE--------- +### EXAMPLE ```powershell Clear-SPServerScaleOutDatabaseTenantData -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -41,13 +40,14 @@ This example clears all data related to the site subscription with id 5CAF2F99-A ### -ServiceApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the service application in which to clear data. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +58,14 @@ Accept wildcard characters: False ### -SiteSubscriptionId +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription id of the site subscription in which to clear data. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +76,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +89,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +100,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +119,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md index 73699d557..170903632 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Clear-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Deletes all data from the Business Data Connectivity Metadata Store for a specified partition. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Clear-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso ``` @@ -39,13 +38,15 @@ This example deletes all data from the Business Data Connectivity Metadata Store ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for which the Business Data Connectivity models are deleted. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Connect-SPConfigurationDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Connect-SPConfigurationDatabase.md index 08cd3adfe..9509f669a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Connect-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Connect-SPConfigurationDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Connects the local server computer to a farm. - ## SYNTAX ``` @@ -38,7 +37,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Connect-SPConfigurationDatabase -DatabaseServer "ServerName\InstanceName" -DatabaseName "SharePointConfigurationDatabaseName" -Passphrase (ConvertTo-SecureString "MyP@ssw0rd" -AsPlainText -Force) Start-Service SPTimerv4 @@ -49,6 +48,9 @@ This example joins the local server computer to a farm that is configured to use ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the configuration database to which to connect the server. The type must be a valid database name; for example, DB1. @@ -56,8 +58,7 @@ The type must be a valid database name; for example, DB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,14 +68,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server on which to create the configuration database. The default value is the local computer name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Passphrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the secure password phrase for connecting the current server to the configuration database. The type must be a valid secure string; for example, MyBDCApp1serverkey. @@ -91,8 +97,7 @@ The type must be a valid secure string; for example, MyBDCApp1serverkey. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 9 @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -SkipRegisterAsDistributedCacheHost + +> Applicable: SharePoint Server Subscription Edition + By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). Use this parameter to not register the server computer as a distributed cache host. @@ -110,8 +118,7 @@ If you want to have a dedicated cache host, then use this parameter to make sure ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 10 @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -132,8 +142,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If this parameter is not specified, the current user is used. @@ -151,8 +163,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailOverPartner + +> Applicable: SharePoint Server Subscription Edition + Specifies the Database Mirroring partner for a SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -LocalServerRole + +> Applicable: SharePoint Server Subscription Edition + Specifies the MinRole assigned to the local server. ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -DatabaseConnectionEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies whether TLS encryption is used for the connection between SharePoint and the database. Mandatory requires that TLS encryption is used. If TLS encryption can't be successfully negotiated, the connection will fail. Optional allows TLS encryption to be used. If the database server requires TLS encryption, then TLS encryption will be used. Otherwise, TLS encryption will not be used. @@ -204,7 +222,7 @@ Databases mounted to SharePoint before the Version 24H2 feature update was insta Type: SqlConnectionEncryptOption Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: True Position: Named Default value: Mandatory @@ -212,13 +230,16 @@ Accept pipeline input: True Accept wildcard characters: False ``` ### -DatabaseServerCertificateHostName + +> Applicable: SharePoint Server Subscription Edition + Sets the host name to use when validating the server certificate for the connection. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Convert-SPWebApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Convert-SPWebApplication.md index 1e03db615..0a493ac6f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Convert-SPWebApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Convert-SPWebApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Converts the authentication mode of a web application. - ## SYNTAX ``` @@ -34,14 +33,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ```powershell Convert-SPWebApplication -Identity "https://" -To Claims -RetainPermissions ``` This example converts a web application specified by the Identity parameter to use the claim authentication mode. -### ------------EXAMPLE 2------- +### EXAMPLE 2 ```powershell Convert-SPWebApplication -Identity "https://" -From Legacy -To Claims -RetainPermissions ``` @@ -51,13 +50,15 @@ This example converts a web application specified by the Identity parameter from ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the web application that you want to convert, for example: https://mysite/app1 ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -From + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication method to convert from. Valid values for this parameter are as follows. @@ -76,8 +80,7 @@ Legacy, Claims-Windows, Claims-Trusted-Default ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -To + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication method to convert to. Valid values for this parameter are as follows. @@ -96,8 +102,7 @@ Claims, Claims-Windows, Claims-Trusted-Default, Claims-SharePoint-Online ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -118,8 +126,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the conversion of the web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,13 +154,15 @@ Accept wildcard characters: False ``` ### -RetainPermissions + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which the cmdlet is run and retains the permission in the web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the content database to migrate. ```yaml Type: SPContentDatabase Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -MapList + +> Applicable: SharePoint Server Subscription Edition + Specifies a file containing as list of rows in the following format: user-key, migrated-user-name, migrated-user-key. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,13 +208,15 @@ Accept wildcard characters: False ``` ### -SiteSubsriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID fo the Site Subscription. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -SkipPolicies + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWebApplication security policies will not be migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -225,13 +244,15 @@ Accept wildcard characters: False ``` ### -SkipSites + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWebApplication's SPSites will not be migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -241,13 +262,15 @@ Accept wildcard characters: False ``` ### -SourceSkipList + +> Applicable: SharePoint Server Subscription Edition + Specifies a file containing as list of rows in the following format: user-key. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -257,13 +280,15 @@ Accept wildcard characters: False ``` ### -TrustedProvider + +> Applicable: SharePoint Server Subscription Edition + When you migrate from a trusted login provider this is how you specify which trusted login provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -273,13 +298,15 @@ Accept wildcard characters: False ``` ### -LoggingDirectory + +> Applicable: SharePoint Server Subscription Edition + Specifies a directory where verbose logs about the results of the migration will be written. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPActivitiesToWorkflowService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPActivitiesToWorkflowService.md index fa4a566c0..20857cddb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPActivitiesToWorkflowService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPActivitiesToWorkflowService.md @@ -13,7 +13,6 @@ schema: 2.0.0 Copies the Workflow Activities from SharePoint to Workflow Manager. Activities are defined within Microsoft provided or custom coded assemblies. - ## SYNTAX ``` @@ -27,7 +26,7 @@ Copies Workflow activities from SharePoint Server to Workflow Manager. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $credential = [System.Net.CredentialCache]::DefaultNetworkCredentials $site = Get-SPSite @@ -36,22 +35,20 @@ $svcAddress = $proxy.GetWorkflowServiceAddress($site) Copy-SPActivitiesToWorkflowService -WorkflowServiceAddress $svcAddress -Credential $credential -Force $true ``` - Copies the Workflow activities from SharePoint to the Workflow Manager farm using the specified Site Collection URL as a reference. - ## PARAMETERS ### -ActivityName + +> Applicable: SharePoint Server Subscription Edition + Copies a specific ActivityName. If not specified, all Activities are copied. ```yaml Type: String Parameter Sets: (All) -Aliases: - -Applicable: SharePoint Server Subscription Edition - +Aliases: Required: False Position: Named @@ -61,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -68,8 +68,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +78,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,13 +96,15 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server Subscription Edition + The credential used to connect to Workflow Manager. ```yaml Type: ICredentials Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,13 +114,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces a specific Activity to be copied to Workflow Manager. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -134,7 +142,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -144,14 +151,15 @@ Accept wildcard characters: False ``` ### -WorkflowServiceAddress -The Workflow Manager farm endpoint URL. +> Applicable: SharePoint Server Subscription Edition + +The Workflow Manager farm endpoint URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPBusinessDataCatalogAclToChildren.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPBusinessDataCatalogAclToChildren.md index 38b40c674..952de0e86 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPBusinessDataCatalogAclToChildren.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPBusinessDataCatalogAclToChildren.md @@ -14,7 +14,6 @@ schema: 2.0.0 Copies a set of permissions of a Business Data Connectivity Metadata Store metadata object to its child objects. - ## SYNTAX ``` @@ -55,7 +54,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ExternalSystem = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext https://contoso -Name "ContosoDatabase" ``` @@ -68,13 +67,15 @@ Make sure that the parent metadata object has the final permissions you want, or ## PARAMETERS ### -MetadataObject + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity metadata object. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPContentTypes.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPContentTypes.md index 13f675b8b..5f3a646e9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPContentTypes.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPContentTypes.md @@ -25,16 +25,19 @@ This cmdlet is used in hybrid scenarios with SharePoint Online to copy Content T ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell -Copy-SPContentTypes -LocalSiteUrl https://localsite/ -LocalTermStoreName "managed metadata service application proxy" -RemoteSiteUrl https://contoso.sharepoint.com/ -ContentTypeNames @("ContentTypeA", "ContentTypeB") -Credential (Get-Credential) +Copy-SPContentTypes -LocalSiteUrl https://localsite/ -LocalTermStoreName "managed metadata service application proxy" -RemoteSiteUrl https://contoso.sharepoint.com/ -ContentTypeNames @("ContentTypeA", "ContentTypeB") -Credential (Get-Credential) ``` -This example migrates the specified content types named: ContentTypeA, ContentTypeB on the local site https://localsite/ whose term store named "managed metadata service application proxy" to the hub site of remote site https://contoso.sharepoint.com/. If the remote site is a hub site, the migration target will be itself. +This example migrates the specified content types named: ContentTypeA, ContentTypeB on the local site https://localsite/ whose term store named "managed metadata service application proxy" to the hub site of remote site https://contoso.sharepoint.com/. If the remote site is a hub site, the migration target will be itself. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -42,8 +45,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -AuthEndpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the AuthEndpoint to use, but not the default one. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -69,13 +73,15 @@ Accept wildcard characters: False ``` ### -ContentTypeNames -Specifies the content type names to be migrated. Can be in a form of an array. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the content type names to be migrated. Can be in a form of an array. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,13 +91,15 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server Subscription Edition + Specifies the administrator account credential of the target SharePoint Online site. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,13 +109,15 @@ Accept wildcard characters: False ``` ### -GraphApiEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the GraphApiEndpoint to use, but not the default one. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,13 +127,15 @@ Accept wildcard characters: False ``` ### -LocalSiteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the migration source. Can be a local site or a local hubsite. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -133,13 +145,15 @@ Accept wildcard characters: False ``` ### -LocalTermStoreName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the local term store of the local site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -149,13 +163,15 @@ Accept wildcard characters: False ``` ### -RemoteSiteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the migration target. You can input a remote site url or remote hub site url, both will be processed to be the hub site url. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSideBySideFiles.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSideBySideFiles.md index 24e5ccf2c..359949989 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSideBySideFiles.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSideBySideFiles.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/copy-spsidebysidefiles -Applicable: SharePoint Server Subscription Edition + title: Copy-SPSideBySideFiles schema: 2.0.0 --- @@ -24,7 +24,7 @@ In SharePoint Server 2016, zero down time in-place upgrade is available. If the ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Copy-SPSideBySideFiles -LogFile "C:\CopySideBySideFiles.log" ``` @@ -34,6 +34,9 @@ This example copies SideBySide files and writes a log data of the copy process t ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -LogFile + +> Applicable: SharePoint Server Subscription Edition + Specifies the fully-qualified logfile name of SideBySide copy operation. If LogFile is not specified, the logfile will be placed in default SharePoint log files folder. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSite.md index 09b67ed7b..58251225e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Makes a copy of a site collection. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------- +### EXAMPLE ```powershell Copy-SPSite https://contoso/sites/OldTeam -DestinationDatabase WSS_Content -TargetUrl https://contoso/sites/NewTeam ``` @@ -44,14 +43,16 @@ This example makes a copy of the https://contoso/sites/OldTeam site collection f ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection to copy. This can be a valid URL or GUID. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -TargetUrl + +> Applicable: SharePoint Server Subscription Edition + The URL that will be used for the destination copy of the site collection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the location where the copy will be sent to. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,13 +122,15 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server Subscription Edition + Use when the site collection is a host-named site collection that allows the site to land on the correct web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -PreserveSiteId + +> Applicable: SharePoint Server Subscription Edition + Specifies if the SiteID is to be saved or not. The valid values are True and False. The default value is False. @@ -138,8 +150,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPTaxonomyGroups.md b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPTaxonomyGroups.md index e4ca674f5..59b139e68 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPTaxonomyGroups.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Copy-SPTaxonomyGroups.md @@ -25,7 +25,7 @@ Use the Copy-SPTaxonomyGroups cmdlet to copy specified Metadata groups from an o ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $credential = Get-Credential Copy-SPTaxonomyGroups -LocalTermStoreName "Managed Metadata Service Application Proxy" -LocalSiteUrl "https://sharepoint" -RemoteSiteUrl "https://contoso.sharepoint.com" -GroupNames "Group1","Group2" -Credential $credential @@ -37,6 +37,8 @@ This example copies two taxonomy groups "Group1" and "Group2" from local Term St ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +50,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -AuthEndpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the Azure Active Directory Graph API authentication endpoint. By default, the well-known endpoint will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server Subscription Edition + Specifies the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. Writes data to remote Term Store, so a Term Store Administrator's credential is needed to perform the operations. @@ -82,8 +88,7 @@ Writes data to remote Term Store, so a Term Store Administrator's credential is ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -GraphApiEndpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the Azure Active Directory Graph API endpoint. By default, the well-known endpoint will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -GroupNames + +> Applicable: SharePoint Server Subscription Edition + Specifies the name array of Taxonomy groups in local on-premises term store that will be copied to remote SharePoint Online Term store. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -LocalSiteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the Url of local SharePoint on-premises site that contains the local Taxonomy Term Store. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -141,13 +152,15 @@ Accept wildcard characters: False ``` ### -LocalTermStoreName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of local Taxonomy Term Store in the SharePoint on-premises farm. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -RemoteSiteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the Url of remote SharePoint Online site that contains remote Taxonomy Term Store. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-ProjectServerLicense.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-ProjectServerLicense.md index 5a165c18c..5cf82d6c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-ProjectServerLicense.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-ProjectServerLicense.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-projectserverlicense -Applicable: SharePoint Server Subscription Edition + title: Disable-ProjectServerLicense schema: 2.0.0 --- @@ -23,7 +23,7 @@ Disables Project Server functionality across the farm. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-ProjectServerLicense ``` @@ -33,6 +33,9 @@ This example disables Project Server functionality for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPAppAutoProvision.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPAppAutoProvision.md index b27ecaf30..7acc905a2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPAppAutoProvision.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPAppAutoProvision.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disables automatic provisioning of an app. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ```powershell Disable-SPAppAutoProvision ``` @@ -38,7 +37,7 @@ This example disables app auto provisioning for the farm. The app auto provisioning is enabled by default. This setting overrides site subscription level setting. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell $subscription = Get-SPSiteSubscription https://Contoso.com Disable-SPAppAutoProvision -SiteSubscription $subscription @@ -50,6 +49,9 @@ The app auto provisioning is enabled by default. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -61,8 +63,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for which auto provisioning is to be disabled. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPBusinessDataCatalogEntity.md index 40a4a8514..22f8f80b5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPBusinessDataCatalogEntity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPBusinessDataCatalogEntity.md @@ -14,7 +14,6 @@ schema: 2.0.0 Deactivates an External Content type in the Business Data Connectivity Metadata Store. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $entityToDisable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso Disable-SPBusinessDataCatalogEntity -Identity $entityToDisable @@ -41,13 +40,15 @@ Note that the terms External Content type and Entity refer to the same object ty ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the External Content type in the Business Data Connectivity Metadata Store to deactivate. ```yaml Type: Entity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPFeature.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPFeature.md index cd2178c41..bde4340e3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPFeature.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPFeature.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disables an installed SharePoint Feature at a given scope. - ## SYNTAX ``` @@ -31,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Disable-SPFeature -identity "MyCustom" -URL https://somesite ``` This example disables the "MyCustom" Web site scoped feature at https://somesite. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell $w = Get-SPWeb https://somesite/myweb | ForEach{ $_.URL } Get-SPFeature -Web $w | ForEach-Object { Disable-SPFeature -Identity $_ -URL $w} @@ -51,6 +50,9 @@ You do not need to use the SPAssignment cmdlets in this case because the Web obj ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Feature or GUID to disable. The type must be the name of the Feature folder located in the "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\[14|15|16]\Template\Features" folder or GUID, in the format 21d186e1-7036-4092-a825-0eb6709e9281. @@ -58,8 +60,7 @@ The type must be the name of the Feature folder located in the "$env:ProgramFile ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +84,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +104,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -108,13 +113,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces a Feature to be disabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +131,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Web application, site collection, or Web site to which the Feature is being disabled. The type must be a valid URL, such as https://server_name. @@ -131,8 +141,7 @@ The type must be a valid URL, such as https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +151,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +161,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPHealthAnalysisRule.md index 9f5b83902..5b4ac9044 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPHealthAnalysisRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disables health analyzer rules. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ```powershell Disable-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -44,6 +43,9 @@ This example disables the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or GUID of the health analyzer rule to disable. The type must be a valid name; an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -51,8 +53,7 @@ The type must be a valid name; an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPInfoPathFormTemplate.md index 5842f1390..d72420726 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPInfoPathFormTemplate.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Disable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site https://testSite ``` @@ -36,6 +36,9 @@ This example deactivates an InfoPath form template from a site collection named ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to disable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -43,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection that contains the InfoPath form template to deactivate. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -62,7 +67,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPSitePipeBind Parameter Sets: (All) Aliases: Url -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index f42c0bf6e..0279f272e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-spprojectactivedirectoryenterpriseresourcepoolsync -Applicable: SharePoint Server Subscription Edition + title: Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync schema: 2.0.0 --- @@ -43,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync https://localhost/pwa ``` @@ -53,13 +53,15 @@ This example disables Timer Job execution of the Active Directory Enterprise Res ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App (PWA) instance to disable Active Directory Enterprise Resource Sync. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEmailNotification.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEmailNotification.md index 8eec2bf86..fa5affcb9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEmailNotification.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEmailNotification.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-spprojectemailnotification -Applicable: SharePoint Server Subscription Edition + title: Disable-SPProjectEmailNotification schema: 2.0.0 --- @@ -24,7 +24,7 @@ Turns off the Project Web App site level setting for email notifications in Proj ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-SPProjectEmailNotification -Url https://pwa_site ``` @@ -34,6 +34,9 @@ Disables Project Server email notifications on the Project Web App site, https:/ ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEnterpriseProjectTaskSync.md index dceb97423..b224fa9fd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectEnterpriseProjectTaskSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-spprojectenterpriseprojecttasksync -Applicable: SharePoint Server Subscription Edition + title: Disable-SPProjectEnterpriseProjectTaskSync schema: 2.0.0 --- @@ -24,7 +24,7 @@ Disables task sync between Project Web App and the associated project site. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-SPProjectEnterpriseProjectTaskSync -Url https://pwa_site ``` @@ -34,6 +34,9 @@ Disables Project Server task sync on the Project Web App site, https://pwa_site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectQueueStatsMonitoring.md index 61d20ed51..8dcf0c209 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectQueueStatsMonitoring.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPProjectQueueStatsMonitoring.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-spprojectqueuestatsmonitoring -Applicable: SharePoint Server Subscription Edition + title: Disable-SPProjectQueueStatsMonitoring schema: 2.0.0 --- @@ -23,7 +23,7 @@ Disables monitoring Project Server queue statistics. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-SPProjectQueueStatsMonitoring ``` @@ -33,6 +33,9 @@ Disables monitoring Project Server queue statistics. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSessionStateService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSessionStateService.md index e6b10d598..3d51ae374 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSessionStateService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSessionStateService.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Disable-SPSessionStateService ``` @@ -40,6 +40,9 @@ This example turns off ASP.NET session state on the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -69,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSingleSignOn.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSingleSignOn.md index d1d39974a..65ec6f1ed 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSingleSignOn.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPSingleSignOn.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Disable-SPSingleSignOn myOldSSO -ServerName CONTOSO ``` @@ -36,13 +36,15 @@ This example turns off the SSO Service on the server named CONTOSO. ## PARAMETERS ### -ServerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the server in which the service is running. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -63,8 +68,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -81,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPTimerJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPTimerJob.md index b452d6322..34885ca49 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPTimerJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPTimerJob.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disables a timer job. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Disable-SPTimerJob job-ceip-datacollection ``` @@ -39,6 +38,9 @@ This example disables the timer job named job-ceip-datacollection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the timer job to disable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserLicensing.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserLicensing.md index 4c69599c1..a1a870e9b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserLicensing.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserLicensing.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disables user license enforcement. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ```powershell Disable-SPUserLicensing ``` @@ -39,6 +38,9 @@ This example disables user license enforcement on the SharePoint farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -68,7 +72,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserSolutionAllowList.md index 09c2f1130..5ffb75edd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPUserSolutionAllowList.md @@ -24,7 +24,7 @@ Disables the user managed solutions gallery capability on the farm. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-SPUserSolutionAllowList ``` @@ -34,6 +34,9 @@ Disables the user managed solutions gallery capability on the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -68,6 +72,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -75,7 +82,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebApplicationHttpThrottling.md index 7c0373a67..fd1d78ee5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebApplicationHttpThrottling.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebApplicationHttpThrottling.md @@ -14,7 +14,6 @@ schema: 2.0.0 Turns off network throttling for a Web application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Disable-SPWebApplicationHTTPThrottling https://sitename ``` @@ -40,6 +39,9 @@ This example disables network throttling on the Web application https://sitename ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Turns off network throttling on the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebTemplateForSiteMaster.md index 9a0638f8d..870636372 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebTemplateForSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disable-SPWebTemplateForSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/disable-spwebtemplateforsitemaster -Applicable: SharePoint Server Subscription Edition + title: Disable-SPWebTemplateForSiteMaster schema: 2.0.0 --- @@ -24,7 +24,7 @@ Use the Disable-SPWebTemplateForSiteMaster cmdlet to disable a site master in th ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Disable-SPWebTemplateForSiteMaster -Template STS#0 ``` @@ -34,6 +34,9 @@ This example disables the template in the site master of a farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -59,8 +64,7 @@ When this parameter is not specified, the CompatibilityLevel parameter will defa ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,13 +74,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the template. For example, SPSPERS#2. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Disconnect-SPConfigurationDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Disconnect-SPConfigurationDatabase.md index 1409b5598..8d8bd5cd3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Disconnect-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Disconnect-SPConfigurationDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Disconnects the local server computer from the farm. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Disconnect-SPConfigurationDatabase -Confirm:$false ``` @@ -41,6 +40,9 @@ This example removes the local server computer from a farm without prompting for ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -70,7 +74,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPContentDatabase.md index 1d7b3d1c0..e03ed312d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPContentDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Detaches a content database from its currently associated Web application. - ## SYNTAX ``` @@ -31,14 +30,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ```powershell Dismount-SPContentDatabase 12345678-90ab-cdef-1234-567890abcdef ``` This example detaches the content database with the GUID 12345678-90ab-cdef-1234-567890abcdef from its current parent Web application. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell Get-SPContentDatabase -WebApplication https://sitename | Dismount-SPContentDatabase -WhatIf ``` @@ -49,6 +48,9 @@ Remove the WhatIf parameter to perform the operation. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database to detach. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -56,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +102,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPStateServiceDatabase.md index ccb9696de..81ccae2c9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Dismount-SPStateServiceDatabase.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Dismount-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example removes the association between the SharePoint farm and the SQL Server database without dropping the SQL Server database. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPStateServiceDatabase -ServiceApplication F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4 | Dismount-SPStateServiceDatabase ``` @@ -44,6 +44,9 @@ This example dismounts a single database because only the Identity parameter is ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to remove from the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -52,7 +55,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-ProjectServerLicense.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-ProjectServerLicense.md index ed603ad7a..d7c94e4ec 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-ProjectServerLicense.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-ProjectServerLicense.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-projectserverlicense -Applicable: SharePoint Server Subscription Edition + title: Enable-ProjectServerLicense schema: 2.0.0 --- @@ -24,7 +24,7 @@ Enables Project Server functionality on the farm. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-ProjectServerLicense -Key XXXXX-XXXXX-XXXXX-XXXXX-XXXXX ``` @@ -34,6 +34,9 @@ This example enables all Project Server functionality in the farm. The type of l ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Key + +> Applicable: SharePoint Server Subscription Edition + License key (trial or full). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPAppAutoProvision.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPAppAutoProvision.md index 4323cd431..30b535079 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPAppAutoProvision.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPAppAutoProvision.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1-------- +### EXAMPLE 1 ```powershell Enable-SPAppAutoProvision ``` @@ -36,7 +36,7 @@ This example enables auto provisioning for the farm. The app auto provisioning is enabled by default. This setting overrides site subscription level setting. -### --------------EXAMPLE 2-------- +### EXAMPLE 2 ```powershell $subscription = Get-SPSiteSubscription https://Contoso.com Enable-SPAppAutoProvision -SiteSubscription $subscription @@ -48,6 +48,9 @@ The app auto provisioning is enabled by default. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -59,8 +62,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for which auto provisioning is to be enabled. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPBusinessDataCatalogEntity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPBusinessDataCatalogEntity.md index 8034fb1de..bce2f6631 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPBusinessDataCatalogEntity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPBusinessDataCatalogEntity.md @@ -14,7 +14,6 @@ schema: 2.0.0 Activates an External Content type in the Business Data Connectivity Metadata Store. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $entityToEnable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso Enable-SPBusinessDataCatalogEntity -Identity $entityToEnable @@ -41,13 +40,15 @@ Note that the terms External Content type and Entity refer to the same object ty ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the External Content type in the Business Data Connectivity Metadata Store to activate. ```yaml Type: Entity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPFeature.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPFeature.md index e57018563..672b13b8c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPFeature.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPFeature.md @@ -28,7 +28,7 @@ Enable-SPFeature [-Identity] [-AssignmentCollectio ``` ## DESCRIPTION -The Enable-SPFeature cmdlet enables an installed feature at the given scope. +The Enable-SPFeature cmdlet enables an installed feature at the given scope. If the feature is a farm feature, no URL is needed. Otherwise, provide the URL where the feature is to be enabled and it will be enabled at the proper scope based on the Feature definition. @@ -42,14 +42,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Enable-SPFeature -identity "MyCustom" -URL https://somesite ``` This example enables the "MyCustom" site scoped SharePoint Feature at https://somesite. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell $w = Get-SPWeb https://somesite/myweb | ForEach{ $_.URL } Get-SPFeature -Web $w |%{ Enable-SPFeature -Identity $_ -URL $w} @@ -60,6 +60,9 @@ This example enables all SharePoint Features in the subsite at https://somesite/ ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Feature or GUID to uninstall. The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. @@ -67,8 +70,7 @@ The type must be the name of the Feature folder located in the 14\Template\Featu ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -117,6 +123,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the activation of a Feature. This causes any custom code associated with the Feature to rerun. @@ -126,8 +135,7 @@ This causes any custom code associated with the Feature to rerun. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,13 +145,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server Subscription Edition + If provided, the cmdlet outputs the Feature definition object after enable. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +163,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Web application, site collection, or Web site for which the Feature is being activated. The type must be a valid URL; for example, https://server_name. @@ -160,8 +173,7 @@ The type must be a valid URL; for example, https://server_name. ```yaml Type: String Parameter Sets: SiteFeature -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,6 +183,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +193,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -188,13 +202,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + {{Fill CompatibilityLevel Description}} ```yaml Type: Int32 Parameter Sets: FarmFeatureDefinition -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPHealthAnalysisRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPHealthAnalysisRule.md index 6cbcda62f..13e797acb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPHealthAnalysisRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Enables a health analyzer rule. - ## SYNTAX ``` @@ -34,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ```powershell Enable-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -44,6 +43,9 @@ This example enables the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or GUID of the health analyzer rule to enable. The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -51,8 +53,7 @@ The type must be a valid name, an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPInfoPathFormTemplate.md index f4dee2a19..763ab853c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPInfoPathFormTemplate.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Enable-SPInfoPathFormTemplate -Identity "FormTemplate.xsn" -Site "https://TestSite" ``` @@ -37,6 +37,9 @@ This example activates an InfoPath form template to a site collection named Test ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to activate. The form template must be an administrator-approved, browser-enabled form template that is available on the server farm. @@ -45,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection that contains the InfoPath form template to activate. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -64,7 +69,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPSitePipeBind Parameter Sets: (All) Aliases: url -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index 799fbaa89..03e3ef5e6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-spprojectactivedirectoryenterpriseresourcepoolsync -Applicable: SharePoint Server Subscription Edition + title: Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync schema: 2.0.0 --- @@ -56,13 +56,15 @@ Retrieves the ObjectGuid values of the Domain Users and Domain Admins Active Dir ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance to enable Active Directory Enterprise Resource Sync. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -72,13 +74,15 @@ Accept wildcard characters: False ``` ### -GroupUids + +> Applicable: SharePoint Server Subscription Edition + The Active Directory Group GUID to synchronize the Enterprise Resource Pool with. ```yaml Type: System.Collections.Generic.IEnumerable`1[System.Guid] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +106,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEmailNotification.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEmailNotification.md index 3d932b872..0caf30ff9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEmailNotification.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEmailNotification.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-spprojectemailnotification -Applicable: SharePoint Server Subscription Edition + title: Enable-SPProjectEmailNotification schema: 2.0.0 --- @@ -24,7 +24,7 @@ Turns on the Project Web App site level setting for email notifications in Proje ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-SPProjectEmailNotification -Url https://pwa_site ``` @@ -34,6 +34,9 @@ Enables Project Server email notifications on the Project Web App site, https:// ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ NOTE: When the Global parameter is used, all objects are contained in the global ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,12 +54,14 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEnterpriseProjectTaskSync.md index a9cfd9b70..38c64a792 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectEnterpriseProjectTaskSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-spprojectenterpriseprojecttasksync -Applicable: SharePoint Server Subscription Edition + title: Enable-SPProjectEnterpriseProjectTaskSync schema: 2.0.0 --- @@ -28,7 +28,7 @@ Enables task sync between Project Web App and the associated project site. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-SPProjectEnterpriseProjectTaskSync -Url https://pwa_site ``` @@ -38,6 +38,9 @@ Enables Project Task sync on the Project Web Apps site, https://pwa_site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectQueueStatsMonitoring.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectQueueStatsMonitoring.md index f14b27c4d..cf3c01349 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectQueueStatsMonitoring.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPProjectQueueStatsMonitoring.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-spprojectqueuestatsmonitoring -Applicable: SharePoint Server Subscription Edition + title: Enable-SPProjectQueueStatsMonitoring schema: 2.0.0 --- @@ -23,7 +23,7 @@ Enables monitoring Project Server queue statistics. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-SPProjectQueueStatsMonitoring ``` @@ -33,6 +33,9 @@ Enables monitoring Project Server queue statistics. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPSessionStateService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPSessionStateService.md index 294865de1..b721bc7b1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPSessionStateService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPSessionStateService.md @@ -38,14 +38,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Enable-SPSessionStateService -DefaultProvision ``` This example enables a ASP.NET session state on a SharePoint Server farm that uses the defaults (database hosted on the configuration database SQL Server, using Windows authentication, 60-minute session time-out). -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Enable-SPSessionStateService -DatabaseName "SessionStateDatabase" -DatabaseServer "localhost" -SessionTimeout 120 ``` @@ -55,6 +55,9 @@ This example enables a ASP.NET session state on a SharePoint Server farm that us ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database for the session state service. The type must be a valid name of a SQL Server database; for example, SessionStateDB1. @@ -62,8 +65,7 @@ The type must be a valid name of a SQL Server database; for example, SessionStat ```yaml Type: String Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -73,14 +75,16 @@ Accept wildcard characters: False ``` ### -DefaultProvision + +> Applicable: SharePoint Server Subscription Edition + Specifies that the default provisioning settings are used. The default provisioning settings are: Windows Authentication, Auto SQL Server (configuration database), and Auto Catalog Name. ```yaml Type: SwitchParameter Parameter Sets: DefaultProvision -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +108,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -129,6 +137,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the database credentials for SQL Authentication used to access the session state service database. If this parameter is not specified, Windows authentication is used. @@ -137,8 +148,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +158,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the host SQL Server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -155,8 +168,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: AdvancedProvision -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,14 +178,16 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time, in minutes, that a ASP .NET session state service will remain active with no user activity. The default value is 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -183,6 +197,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -190,7 +207,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPTimerJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPTimerJob.md index 07c88d574..7fa1d056b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPTimerJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPTimerJob.md @@ -14,7 +14,6 @@ schema: 2.0.0 Enables a timer job. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Get-SPTimerJob job-ceip-datacollection | Enable-SPTimerJob ``` @@ -40,6 +39,9 @@ This example enables the timer job named job-ceip-datacollection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the timer job to enable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserLicensing.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserLicensing.md index 2650a380b..d1b80bd0b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserLicensing.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserLicensing.md @@ -14,7 +14,6 @@ schema: 2.0.0 Enables user-license enforcement. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ```powershell Enable-SPUserLicensing ``` @@ -39,6 +38,9 @@ This example enables user-license enforcement on the SharePoint farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -68,7 +72,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserSolutionAllowList.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserSolutionAllowList.md index 6a1be7862..6cc812198 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPUserSolutionAllowList.md @@ -24,7 +24,7 @@ Enables the user managed solutions gallery capability on the farm. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-SPUserSolutionAllowList ``` @@ -34,6 +34,9 @@ This example enables a user managed solutions gallery on the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -68,6 +72,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -75,7 +82,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebApplicationHttpThrottling.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebApplicationHttpThrottling.md index e7ec78e1a..0cc1bedf0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebApplicationHttpThrottling.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebApplicationHttpThrottling.md @@ -14,7 +14,6 @@ schema: 2.0.0 Turns on network throttling for a Web application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Enable-SPWebApplicationHttpThrottling https://sitename ``` @@ -40,6 +39,9 @@ This example enables network throttling on the https://sitename Web application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Turns on network throttling on the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebTemplateForSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebTemplateForSiteMaster.md index a9058bd9a..7ee4d8e03 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebTemplateForSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Enable-SPWebTemplateForSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/enable-spwebtemplateforsitemaster -Applicable: SharePoint Server Subscription Edition + title: Enable-SPWebTemplateForSiteMaster schema: 2.0.0 --- @@ -24,7 +24,7 @@ Use the Enable-SPWebTemplateEnabledForSiteMaster cmdlet to create a site master ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Enable-SPWebTemplateForSiteMaster -Template STS#0 -CompatibilityLevel 15 ``` @@ -34,6 +34,9 @@ This example creates a site master in the database using the Team Site template. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -59,8 +64,7 @@ When this parameter is not specified, the CompatibilityLevel parameter will defa ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,13 +74,15 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the template. For example, SPSPERS#2. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPAppPackage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPAppPackage.md index 4187e5bf0..2323afad5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPAppPackage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPAppPackage.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------- +### EXAMPLE ```powershell $instance = Get-SPAppInstance -AppInstanceId $instance.Id Export-SPAppPackage -App $instance.App -Path .\exported.spapp @@ -38,13 +38,15 @@ This example exports an app package to the \exported.spapp location. ## PARAMETERS ### -App + +> Applicable: SharePoint Server Subscription Edition + Specifies the App for which to export the package. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the exported file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +88,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPBusinessDataCatalogModel.md index a512ba06b..9bce0ee1f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPBusinessDataCatalogModel.md @@ -14,7 +14,6 @@ schema: 2.0.0 Exports a Business Data Connectivity Model. - ## SYNTAX ``` @@ -24,7 +23,7 @@ Export-SPBusinessDataCatalogModel -Identity -Path ``` ## DESCRIPTION -The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. +The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). The Model type contains the base XML metadata, and can also include resource properties. The Resource type includes only resource properties. @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceContext http://contoso Export-SPBusinessDataCatalogModel -Identity $Model -Path "C:\folder\model.bdcm" @@ -44,13 +43,15 @@ This example gets a Business Data Connectivity Model from the Business Data Conn ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object from which to export the Business Data Connectivity Model. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name to use to create the export file. The type must be a valid path in either of the following forms: @@ -71,8 +75,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites the output file if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that names for business data fields in multiple languages are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,14 +145,16 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that models are included in the exported Business Data Connectivity Model file. A model contains the base XML metadata for a system. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,13 +164,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that permissions from the Business Data Connectivity Model are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,13 +182,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that properties from the application definition are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that proxies for Business Data Connectivity Service applications are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom environment settings model slice to export. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -208,8 +228,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCacheClusterConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCacheClusterConfig.md index b315e9f91..1bff36ede 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCacheClusterConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCacheClusterConfig.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Export-SPCacheClusterConfig -Path C:\Config.txt ``` @@ -36,6 +36,9 @@ This example exports cache cluster configuration details to C:\Config.txt. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,7 +51,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the exported file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -97,7 +106,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCertificate.md index 64fcb8fda..d15aa7d04 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPCertificate.md @@ -32,22 +32,22 @@ Exports certificates from the SharePoint farm into a certificate file. This exported certificate file is stored in the Central Administration site by default, but can also be stored in a path specified by the Path parameter. SharePoint supports exporting certificates to PFX (PKCS #12) files, P7B (PKCS #7) files, and CER files. -Both PFX files and P7B files can contain multiple certificates, which is useful for exporting a chain of certificates from the end entity (leaf) certificate to the root certificate. +Both PFX files and P7B files can contain multiple certificates, which is useful for exporting a chain of certificates from the end entity (leaf) certificate to the root certificate. However, only PFX files can contain private keys for certificates, which are necessary for a server certificate to be assigned to an IIS web site. CER files contain only a single certificate. ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell -$password = ConvertTo-SecureString -AsPlainText -Force - +$password = ConvertTo-SecureString -AsPlainText -Force + Export-SPCertificate -Identity "Team Sites Certificate" -Password $password -IncludeAllCertificatesInCertificationPath -Path "\\server\fileshare\certificates.pfx" ``` This example exports the "Team Sites Certificate" certificate and its private key, as well as other certificates in its certificate chain, to the \\\\server\fileshare\certificates.pfx file. -### ------------EXAMPLE 2----------- +### EXAMPLE 2 ```powershell Export-SPCertificate -Identity "Team Sites Certificate" -Type Cert ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPEnterpriseSearchTopology.md index dac1db6dd..803148c73 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPEnterpriseSearchTopology.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Export-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename topology.xml @@ -37,6 +37,9 @@ This example exports the topology to a file named topology.xml in the search ser ## PARAMETERS ### -Filename + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and file name to use to create the topology XML file. The type must be a valid path, in the form MyFeature\Feature.xml. @@ -44,8 +47,7 @@ The type must be a valid path, in the form MyFeature\Feature.xml. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application with the topology to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -62,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPInfoPathAdministrationFiles.md index b88aa05ba..e096d5d3d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPInfoPathAdministrationFiles.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPInfoPathAdministrationFiles.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Export-SPInfoPathAdministrationFiles -path d:\file.cab ``` @@ -38,6 +38,9 @@ This example saves all InfoPath form templates (.xsn files) and universal data c ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the location and name of the output .cab file. The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. @@ -45,8 +48,7 @@ The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection that contains the InfoPath form template and Central Administration .udcx files to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -102,8 +111,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPMetadataWebServicePartitionData.md index 9214eba1e..62a3683fd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPMetadataWebServicePartitionData.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE-------------- +### EXAMPLE ```powershell Export-SPMetadataWebServicePartitionData -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -Path "\\server_name\folder_name\file_name.cab" ``` @@ -37,6 +37,9 @@ This example creates a backup of data for a specific site subscription on a Meta ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription to export. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the service proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -62,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and file name for the file to create from the exported data. The type must be a valid path in either of the following forms: @@ -83,8 +90,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,13 +124,15 @@ Accept wildcard characters: False ``` ### -NoCompression + +> Applicable: SharePoint Server Subscription Edition + {{Fill NoCompression Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPScaleOutDatabaseTenantData.md index 842135af0..be0d8bc7d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPScaleOutDatabaseTenantData.md @@ -14,7 +14,6 @@ schema: 2.0.0 Exports the data of the specified subscription. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE------- +### EXAMPLE ```powershell Export-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -40,13 +39,15 @@ This example exports data for the site subscription with id 5CAF2F99-A75F-4239-B ## PARAMETERS ### -FilePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the output path for the file to export the data to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +57,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to export the data from. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,13 +75,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription id of the site subscription to export the data from. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +107,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,13 +136,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites an existing data file without prompting for confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +164,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPServerScaleOutDatabaseTenantData.md index 0cb6e9b36..7644a8d5e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPServerScaleOutDatabaseTenantData.md @@ -25,10 +25,9 @@ Export-SPServerScaleOutDatabaseTenantData [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: SharePoint Server Subscription Edition + {{Fill FilePath Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,13 +109,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + {{Fill ServiceApplication Description}} ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,13 +127,15 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + {{Fill SiteSubscriptionId Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -134,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -141,7 +155,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md index 236d28d53..935e8d2e6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Exports all data from the Business Data Connectivity Metadata Store associated with a partition. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Export-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -Path "C:\folder\exportedFile.xml" ``` @@ -41,6 +40,9 @@ This example exports the data file named exportedFile.xml. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name to use to create the export file. The type must be a valid path in either of the following forms: @@ -52,8 +54,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context of the data to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -70,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +98,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +118,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,13 +127,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites the output file if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that names for business data fields in multiple languages are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,13 +163,15 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that Business Data Connectivity models are included in the exported file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,13 +181,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that permissions from the Business Data Connectivity Models are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,13 +199,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that properties from the Business Data Connectivity Models are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,13 +217,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that proxies for Business Data Connectivity Service applications are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,6 +235,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -223,7 +245,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionSettings.md index 8cd3e919d..9a2d4d9f8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPSiteSubscriptionSettings.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a backup file of site subscription data. - ## SYNTAX ``` @@ -29,15 +28,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Export-SPSiteSubscriptionSettings -Identity "https://siteCollection" -Path "C:\siteCollection_sitesubscriptionsettings.txt" ``` The example backs up the subscription settings store of https://siteCollection. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell $site = Get-SPSite https://siteCollection Export-SPSiteSubscriptionSettings -Identity $site.SiteSubscription -Path "C:\siteCollection_sitesubscriptionsettings.txt" @@ -48,6 +46,9 @@ The example backs up the subscription settings store of https://siteCollection u ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the site subscription from which to back up data. The type must be a valid URL, in the form https://server_name or a Site Subscription object. @@ -55,8 +56,7 @@ The type must be a valid URL, in the form https://server_name or a Site Subscrip ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +66,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the location of the output file. The type must be a valid path; for example, C:/backupfile.back.. @@ -73,8 +76,7 @@ The type must be a valid path; for example, C:/backupfile.back.. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,14 +86,16 @@ Accept wildcard characters: False ``` ### -AdminProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies that only administrator subscription properties are exported. If this parameter is not set, only non-administrator subscription properties are exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +119,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,13 +129,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the output backup file (if provided) to overwrite any existing file at the given path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPTagsAndNotesData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPTagsAndNotesData.md index af6ca7f01..ce5f38719 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPTagsAndNotesData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPTagsAndNotesData.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/export-sptagsandnotesdata -Applicable: SharePoint Server Subscription Edition + title: Export-SPTagsAndNotesData schema: 2.0.0 --- @@ -25,7 +25,7 @@ The tags and notes are written into separate files, and then the two are compres ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ```powershell Export-SPTagsAndNotesData -Site https://site.contoso.com -FilePath C:\TagsAndNotes.zip ``` @@ -35,6 +35,9 @@ This example creates a new ZIP file called TagsAndNotes.zip, on the root of C: d ## PARAMETERS ### -Site + +> Applicable: SharePoint Server Subscription Edition + URL of the root site where you want to export the tags and notes from. You must specify a valid URL to an existing SharePoint root site. @@ -43,8 +46,7 @@ For example: https://site.contoso.com ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: SharePoint Server Subscription Edition + File name, including full path, that you want export the tags and notes to. The cmdlet will create a new ZIP file with the name you specified. @@ -62,8 +67,7 @@ If the file already exists, the cmdlet won't perform the export and will ask you ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPWeb.md index 6c28a7379..768a539dd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Export-SPWeb.md @@ -14,7 +14,6 @@ schema: 2.0.0 Exports a site, list, or library. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE-----------------------. +### EXAMPLE. ```powershell Export-SPWeb https://site -Path "C:\Temp\export.cmp" ``` @@ -42,6 +41,9 @@ This example exports the site at https://site/ to a file called site export.cmp ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the Web to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint site (for example, MySPSite1); or an instance of a valid SPWeb object. @@ -49,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the export file. If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. @@ -67,8 +71,7 @@ If the NoFileCompression parameter is used, a directory must be specified; other ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,11 +81,13 @@ Accept wildcard characters: False ``` ### -AppLogFilePath + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +111,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,14 +121,16 @@ Accept wildcard characters: False ``` ### -CompressionSize + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum file size for the compressed export files. If the total size of the exported package is greater than this size, the exported package will be split into multiple files. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forcefully overwrites the export package if it already exists. The type must be either of the following values: @@ -161,8 +175,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -HaltOnError + +> Applicable: SharePoint Server Subscription Edition + Stops the export process when an error occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -HaltOnWarning + +> Applicable: SharePoint Server Subscription Edition + Stops the export process when a warning occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,13 +222,14 @@ Accept wildcard characters: False ### -IncludeUserSecurity +> Applicable: SharePoint Server Subscription Edition + Preserves the user security settings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,6 +239,9 @@ Accept wildcard characters: False ``` ### -IncludeVersions + +> Applicable: SharePoint Server Subscription Edition + Indicates the type of file and list item version history to be included in the export operation. If the IncludeVersions parameter is absent, the Export-SPWeb cmdlet by default uses a value of 1. @@ -241,8 +262,7 @@ All, CurrentVersion, LastMajor, LastMajorAndMinor ```yaml Type: SPIncludeVersions Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -252,6 +272,9 @@ Accept wildcard characters: False ``` ### -ItemUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Web application, GUID, or object to be exported. The type must be a valid URL; for example, https://server_name. @@ -259,8 +282,7 @@ The type must be a valid URL; for example, https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -270,6 +292,9 @@ Accept wildcard characters: False ``` ### -NoFileCompression + +> Applicable: SharePoint Server Subscription Edition + Either enables or disables file compression in the export package. The export package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. @@ -278,8 +303,7 @@ If compression is enabled, the export process can increase by approximately 30 p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -289,6 +313,9 @@ Accept wildcard characters: False ``` ### -NoLogFile + +> Applicable: SharePoint Server Subscription Edition + Suppresses the generation of an export log file. If this parameter is not specified, the Export-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS). @@ -299,8 +326,7 @@ However, for performance reasons, you might not want to generate a log file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -310,14 +336,16 @@ Accept wildcard characters: False ``` ### -UseSqlSnapshot + +> Applicable: SharePoint Server Subscription Edition + Specifies a SQL Database Snapshot will be created when the export process begins, and all exported data will be retrieved directly from the database snapshot. This snapshot will be automatically deleted when export completes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -327,6 +355,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -334,7 +365,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -344,13 +374,15 @@ Accept wildcard characters: False ``` ### -IncludeAlerts + +> Applicable: SharePoint Server Subscription Edition + Indicates if alerts are turned on. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-ProjectServerLicense.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-ProjectServerLicense.md index 5a5666013..7c32f8e3d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-ProjectServerLicense.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-ProjectServerLicense.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-projectserverlicense -Applicable: SharePoint Server Subscription Edition + title: Get-ProjectServerLicense schema: 2.0.0 --- @@ -23,7 +23,7 @@ Retrieves the status of the license for Project Server. If the current license i ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-ProjectServerLicense ``` @@ -33,6 +33,9 @@ Gets the status of the Project Server license and when it was activated. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAlternateURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAlternateURL.md index 83eb57a4b..2b8716a9a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAlternateURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAlternateURL.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all alternate URLs that match a given set of criteria. - ## SYNTAX ### ResourceName @@ -45,14 +44,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPAlternateURL -WebApplication https://sitename ``` This example displays all the alternate URLs on a given Web application. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPAlternateURL -ResourceName "MyResource" ``` @@ -62,6 +61,9 @@ This example displays all the alternate URLs for a given resource. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the alternate URL to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or a valid URL, in the form https://server_name. @@ -69,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -ResourceName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the resource from which to list alternate URLs. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application from which to list alternate URLs. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +131,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the five zones with which the alternate URLs is associated. Must be a valid zone: Default, Intranet, Internet, Extranet, or Custom @@ -141,8 +151,7 @@ Must be a valid zone: Default, Intranet, Internet, Extranet, or Custom ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAcquisitionConfiguration.md index bac51d23b..396ed5490 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAcquisitionConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAcquisitionConfiguration.md @@ -37,15 +37,14 @@ Use the `Get-SPAppAcquisitionConfiguration` cmdlet to return app acquisition set ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ```powershell Get-SPAppAcquisitionConfiguration -WebApplication https://localhost ``` This example returns app acquisition settings for the specified web application. - -### ------------EXAMPLE 2------- +### EXAMPLE 2 ```powershell Get-SPAppAcquisitionConfiguration -SiteSubscription https://localhost/sites/SharePointOnlineAdmin ``` @@ -56,13 +55,14 @@ This example returns app acquisition settings for the specified tenant. ### -SiteSubscription +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for which app acquisition settings are to be returned. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -73,6 +73,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -80,8 +82,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,13 +93,14 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the web application for which app acquisition settings are to be returned. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAutoProvisionConnection.md index 914606e37..2fdd6e362 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAutoProvisionConnection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppAutoProvisionConnection.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns provision connection settings for an app. - ## SYNTAX ``` @@ -29,14 +28,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell Get-SpAppAutoProvisionConnection ``` This example returns the entire app auto provisioning connection information for the default site subscription. -### ---------------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell $subscription = Get-SPSiteSubscription https://Contoso.com Get-SPAppAutoProvisionConnection -SiteSubscription $subscription -ConnectionType RemoteWebHost @@ -47,6 +46,9 @@ This example returns the remote web host app auto provisioning connection inform ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -58,8 +60,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -69,13 +70,15 @@ Accept wildcard characters: False ``` ### -ConnectionType + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection type to provision the app. ```yaml Type: ConnectionTypes Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection from which to return the provision connection. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDeniedEndpointList.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDeniedEndpointList.md index 54cb2fd8c..021daef25 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDeniedEndpointList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDeniedEndpointList.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the app-denied endpoint list for the entire farm. - ## SYNTAX ``` @@ -27,21 +26,21 @@ Use the Get-SPAppEndpoint cmdlet to return the app-denied endpoint list for the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE---------- +### EXAMPLE ```powershell Get-SPAppDeniedEndpoint ``` This example returns all the app-denied endpoints within the farm. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDisablingConfiguration.md index 7140533a2..7d7567178 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDisablingConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDisablingConfiguration.md @@ -26,21 +26,21 @@ Use the Get-SPAppDisablingConfiguration cmdlet to return the disable sync list s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------- +### EXAMPLE ```powershell Get-SPAppDisablingConfiguration ``` This example returns disable list sync state of a pp. - ## PARAMETERS ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDomain.md index 308685144..5f0b4c576 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppDomain.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the domain used to host apps. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Get-SPAppDomain ``` @@ -38,6 +37,9 @@ This example returns the domain name that hosts apps in the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppHostingQuotaConfiguration.md index f1685d239..f3cf26608 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppHostingQuotaConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppHostingQuotaConfiguration.md @@ -26,14 +26,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1--------- +### EXAMPLE 1 ```powershell Get-SPAppHostingQuotaConfiguration -Identity '586d4a32-98c3-42ce-80be-3c76c10c250c' ``` This example returns the hosted app quota associated to SiteSubscriptionID "586d4a32-98c3-42ce-80be-3c76c10c250c". -### --------------EXAMPLE 1--------- +### EXAMPLE 1 ```powershell Get-SPSiteSubscription | Get-SPAppHostingQuotaConfiguration -Identity $_ ``` @@ -44,6 +44,8 @@ This example returns the hosted app quota associated for all site subscriptions ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +53,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,13 +64,14 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,6 +82,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -87,7 +91,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription from which to get site collections. The type must be a valid URL, in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -104,8 +110,7 @@ The type must be a valid URL, in the form, https://server_name or a valid GUID ( ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppInstance.md index 9ce73d1c0..d556e9139 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppInstance.md @@ -44,7 +44,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Get-SPAppInstance -Web https://localhost ``` @@ -52,7 +52,7 @@ Get-SPAppInstance -Web https://localhost This example returns a collection if more than one app is installed on https://localhost. If only one app is installed, a single object is returned. -### -----------EXAMPLE 2----------- +### EXAMPLE 2 ```powershell Get-SPAppInstance -AppInstanceId $instance.Id ``` @@ -62,13 +62,15 @@ This example returns the ID of an instance of an app. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the App instance for which to find metadata. ```yaml Type: SPAppInstance Parameter Sets: IdentityParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Sets the query scope to a site. Subsites are not included. @@ -85,8 +90,7 @@ Subsites are not included. ```yaml Type: SPSitePipeBind Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,6 +100,9 @@ Accept wildcard characters: False ``` ### -App + +> Applicable: SharePoint Server Subscription Edition + Specifies the App. This parameter returns metadata for all instances of an app. @@ -103,8 +110,7 @@ This parameter returns metadata for all instances of an app. ```yaml Type: SPApp Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +120,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -125,8 +134,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,13 +144,15 @@ Accept wildcard characters: False ``` ### -AppInstanceId + +> Applicable: SharePoint Server Subscription Edition + Specifies the App Instance ID to display. ```yaml Type: Guid Parameter Sets: SiteAndIdParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -152,13 +162,15 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWeb object. ```yaml Type: SPWebPipeBind Parameter Sets: WebParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppPrincipal.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppPrincipal.md index 711a309b4..65f0ae63b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppPrincipal.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppPrincipal.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays a specific app principal object. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE-------- +### EXAMPLE ```powershell Get-SPAppPrincipal -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" ``` @@ -39,13 +38,15 @@ This example returns the app principal for a specified ID. ## PARAMETERS ### -NameIdentifier + +> Applicable: SharePoint Server Subscription Edition + Specifies the app principal's name identifier to search for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,11 +56,13 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +86,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppScaleProfile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppScaleProfile.md index ada964c4f..bba4876d7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppScaleProfile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppScaleProfile.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Get-SPAppScaleProfile ``` @@ -37,6 +37,8 @@ This example returns the farm level app scale profile. ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppSiteSubscriptionName.md index 600b6de00..2052c4f82 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppSiteSubscriptionName.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppSiteSubscriptionName.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the name of the specified site subscription. - ## SYNTAX ``` @@ -29,14 +28,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------- +### EXAMPLE 1 ```powershell Get-SPAppSiteSubscriptionName ``` This example returns the name of the default site subscription. -### ------------EXAMPLE 2------- +### EXAMPLE 2 ```powershell Get-SPAppSiteSubscriptionName -SiteSubscription https://www.contoso.com ``` @@ -46,6 +45,9 @@ This example returns the name of the site subscription for SPSite https://www.co ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,8 +59,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. If this parameter is not specified, then the default site subscription is used. All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. @@ -75,8 +79,7 @@ All SharePoint SPSites are members of the default site subscription if they have ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateSyncLastRunTime.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateSyncLastRunTime.md index 25f8f3a6c..22c3070d3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateSyncLastRunTime.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateSyncLastRunTime.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the latest time the app state update job was invoked. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------ +### EXAMPLE ```powershell Get-SPAppStateSyncLastRunTime ``` @@ -39,6 +38,9 @@ This example returns the latest time the app state update job was invoked. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateUpdateInterval.md index 9ad7a16dc..ad90ee6ab 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStateUpdateInterval.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ```powershell Get-SPAppStateUpdateInterval ``` @@ -37,6 +37,9 @@ This example returns the app state update timer job invocation interval in hours ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreConfiguration.md index dcdeb9e44..66f09e345 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreConfiguration.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ```powershell Get-SPAppStoreConfiguration ``` @@ -38,6 +38,8 @@ This example returns the settings for all of the apps. ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreWebServiceConfiguration.md index 7a7ce5df0..dff9efb29 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreWebServiceConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAppStoreWebServiceConfiguration.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spappstorewebserviceconfiguration -Applicable: SharePoint Server Subscription Edition + title: Get-SPAppStoreWebServiceConfiguration schema: 2.0.0 --- @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPAppStoreWebServiceConfiguration ``` @@ -37,6 +37,9 @@ This example returns the product type and version for a SharePoint Store app. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationProvider.md index 57a578880..17e09dccf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns an authentication provider. - ## SYNTAX ``` @@ -31,16 +30,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPAuthenticationProvider -WebApplication https://webAppUrl -Zone Default ``` -This example retrieves the authentication provider in the Default zone of the Web Application 'https://webAppUrl'. +This example retrieves the authentication provider in the Default zone of the Web Application 'https://webAppUrl'. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint authentication provider (for example, NTLM); or an instance of a valid SPAuthenticationProvider object. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPAuthenticationProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Returns the content databases for the specified Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -66,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application zone or zones for which to return the authentication provider. The type must be any one of the valid zones: Default, Intranet, Internet, Extranet, or Custom. @@ -84,8 +90,7 @@ The type must be any one of the valid zones: Default, Intranet, Internet, Extran ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -102,8 +110,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationRealm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationRealm.md index ab27289fd..3cc1e3e0d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationRealm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAuthenticationRealm.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPAuthenticationRealm ``` @@ -37,14 +37,16 @@ This example displays the authentication realms in the entire farm. ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for which the realm needs to be displayed. For example, $root.web. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAvailabilityGroupStatus.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAvailabilityGroupStatus.md index 9ad04a5a2..a0231b6c5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAvailabilityGroupStatus.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPAvailabilityGroupStatus.md @@ -24,9 +24,9 @@ Returns one or more objects representing the availability groups known to the Sh ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell -Get-SPAvailabilityGroupStatus -Identity MyAvailabilityGroup +Get-SPAvailabilityGroupStatus -Identity MyAvailabilityGroup ``` This example returns an availability group named "MyAvailabilityGroup". @@ -34,15 +34,17 @@ This example returns an availability group named "MyAvailabilityGroup". ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Finds the availability group whose name property matches this string. Otherwise, returns all availability groups. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBackupHistory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBackupHistory.md index 02460fb2c..12a4150ba 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBackupHistory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBackupHistory.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a history of backup and restore operations. - ## SYNTAX ``` @@ -30,21 +29,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPBackupHistory -Directory \\file_server\share\Backup ``` This example returns all farm backup and restore operations that have been run for the \\\\file_server\share\Backup directory. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPBackupHistory -Directory C:\Backup -ShowBackup ``` This example returns all of the farm backup operations that have been run for the C:\Backup directory. -### ------------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell (Get-SPBackupHistory -Directory C:\Backup -ShowBackup)[0].SelfId | Restore-SPFarm -Directory C:\Backup -RestoreMethod overwrite ``` @@ -55,6 +54,9 @@ The Restore-SPFarm cmdlet will then perform an overwrite restore from that backu ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server Subscription Edition + Specifies the path where the SharePoint Products backup packages generated from a farm backup have been stored. The type must be a valid path in either of the following forms: @@ -65,8 +67,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,14 +101,16 @@ Accept wildcard characters: False ``` ### -ShowBackup + +> Applicable: SharePoint Server Subscription Edition + Filters the output so that the history of backup operations only is displayed. If both the ShowBackup and the ShowRestore parameters are not specified, the history of both backup and restore operations is displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,14 +120,16 @@ Accept wildcard characters: False ``` ### -ShowRestore + +> Applicable: SharePoint Server Subscription Edition + Filters the output so that the history of restore operations only is displayed. If both the ShowBackup and the ShowRestore parameters are absent, the history of both backup and restore operations is displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsBlock.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsBlock.md index 4a1d28b36..b5ee4f876 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsBlock.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsBlock.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns Bing Maps blocked status. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPBingMapsBlock ``` @@ -39,6 +38,9 @@ This example returns an object, and BlockBingMapsInAllLocales property will retu ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsKey.md index 3e0999ce3..61bba7b4b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBingMapsKey.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the Bing Maps key. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPBingMapsKey ``` @@ -38,6 +37,9 @@ This example returns the Bing Maps key for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBrowserCustomerExperienceImprovementProgram.md index 9b5b6935c..ca1ee4bed 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBrowserCustomerExperienceImprovementProgram.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBrowserCustomerExperienceImprovementProgram.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the current opt-in state for the browser Customer Experience Improvement Program. - ## SYNTAX ### Farm @@ -46,14 +45,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Get-SPBrowserCustomerExperienceImprovementProgram -WebApplication https://WebAppexample1 ``` This example returns the current Customer Experience Improvement Program opt-in state for the Web application, WebAppexample1. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPSiteSubscription https://SiteSubscription1 | Get-SPBrowserCustomerExperienceImprovementProgram ``` @@ -63,13 +62,15 @@ The following example returns the Customer Experience Improvement Program opt-in ## PARAMETERS ### -Farm + +> Applicable: SharePoint Server Subscription Edition + Specifies that the opt-in state for the farm is returned by this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Returns the opt-in state for the specified site subscription. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. @@ -86,8 +90,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Returns the opt-in state for the specified SharePoint Web application. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -104,8 +110,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -122,8 +130,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogEntityNotificationWeb.md index 6ad672551..875ce75eb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogEntityNotificationWeb.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the entity notification site. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPBusinessDataCatalogEntityNotificationWeb -ServiceContext "http://contoso" ``` @@ -39,13 +38,15 @@ This example returns the entity notification site for the site collection at htt ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for which the entity notification web has to be returned. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogMetadataObject.md index bfe5ecaae..eab26d214 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogMetadataObject.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceConext http://contoso ``` @@ -42,6 +41,9 @@ This example gets a metadata object of type Model with the name ContosoModel fro ## PARAMETERS ### -BdcObjectType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of the metadata object to return. The type must be one of the following valid metadata object types: Catalog, Model, LobSystem, LobSystemInstance, or Entity. @@ -49,8 +51,7 @@ The type must be one of the following valid metadata object types: Catalog, Mode ```yaml Type: PSBdcObjectType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,13 +61,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context of the Business Data Connectivity Metadata Store metadata object to return. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,13 +99,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the metadata object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,13 +117,15 @@ Accept wildcard characters: False ``` ### -Namespace + +> Applicable: SharePoint Server Subscription Edition + Specifies the namespace of the metadata object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,13 +135,15 @@ Accept wildcard characters: False ``` ### -ContainingLobSystem + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the LobSystem. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogThrottleConfig.md index 9521c142b..5efdaba96 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogThrottleConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPBusinessDataCatalogThrottleConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the throttling configuration for a Business Data Connectivity Service application. - ## SYNTAX ### FileBackedProvided @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy ``` @@ -51,13 +50,15 @@ This example returns the throttling information that is related to database item ## PARAMETERS ### -FileBacked + +> Applicable: SharePoint Server Subscription Edition + Requests the throttling configuration for file backed metadata catalogs. ```yaml Type: SwitchParameter Parameter Sets: FileBackedProvided -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Returns the throttling configuration for the specified the scope. The type must be one of the following: Wcf, WebService, Database, Global, or Custom. @@ -74,8 +78,7 @@ The type must be one of the following: Wcf, WebService, Database, Global, or Cus ```yaml Type: ThrottleScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Service application proxy that contains the throttling configuration to get. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: ProxyProvided -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -ThrottleType + +> Applicable: SharePoint Server Subscription Edition + Returns the throttling configuration for the specified throttle type. The type must be one of the following: None, Items, Size, Connections, or Timeout. @@ -108,8 +116,7 @@ The type must be one of the following: None, Items, Size, Connections, or Timeou ```yaml Type: ThrottleType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -126,8 +136,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCache.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCache.md index ca0d65f8f..b2fac2130 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCache.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCache.md @@ -23,7 +23,7 @@ Use the Get-SPCache cmdlet to get the cache information from the cache cluster. ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCache ``` @@ -33,6 +33,9 @@ This example returns the cache information of the local machine from the cluster ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -45,7 +48,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -71,6 +75,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -78,7 +85,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterHealth.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterHealth.md index 40d617ad1..514afffbe 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterHealth.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterHealth.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCacheClusterHealth ``` @@ -37,6 +37,9 @@ This example returns health statistics for all of the named caches in the cache ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,7 +52,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -82,7 +89,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterInfo.md index 21b3e1f6d..b31ba20a8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheClusterInfo.md @@ -24,7 +24,7 @@ Use the Get-SPCacheClusterInfo cmdlet to get the cache cluster information in th ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCacheClusterInfo ``` @@ -34,6 +34,9 @@ This example returns the cache cluster information configured in the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -79,7 +86,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHost.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHost.md index 629721bf0..48660f697 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHost.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHost.md @@ -24,7 +24,7 @@ Use the Get-SPCacheHost cmdlet to get the cache host information from the cache ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCacheHost -HostName SP01 -CachePort 22233 ``` @@ -34,6 +34,9 @@ This example returns the cache host information of machine SP01 from the culster ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -CachePort + +> Applicable: SharePoint Server Subscription Edition + The cache port number. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -HostName + +> Applicable: SharePoint Server Subscription Edition + The name of cache host server. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -104,6 +112,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -111,7 +122,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHostConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHostConfig.md index 7e4300ead..de8ab0045 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHostConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheHostConfig.md @@ -24,7 +24,7 @@ Use the Get-SPCacheHostConfig cmdlet to get the cache host config information in ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCacheHostConfig -HostName SP01 ``` @@ -34,6 +34,9 @@ This example returns the host config information of machine SP01 in the culster. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -HostName + +> Applicable: SharePoint Server Subscription Edition + The name of cache host machine. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -95,7 +104,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheStatistics.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheStatistics.md index 362ff8a71..f5c0844a7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheStatistics.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCacheStatistics.md @@ -24,7 +24,7 @@ Use the Get-SPCacheStatistics cmdlet to get the name cache state. ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPCacheStatistics -CacheName DistributedAccessCache_b6c5efa9-e390-4d47-aa8a-45232229992b ``` @@ -34,6 +34,9 @@ This example returns the information of cache 'DistributedAccessCache_b6c5efa9-e ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -CacheName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of cache. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -95,7 +104,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificate.md index 0945ac1ae..e967205f9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificate.md @@ -33,14 +33,14 @@ If no parameters are specified, all certificates in the farm are returned. ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Get-SPCertificate -DisplayName "Team Sites Certificate" ``` This example gets all certificates in the farm with the display name "Team Sites Certificate". -### ------------EXAMPLE 2----------- +### EXAMPLE 2 ```powershell Get-SPCertificate -InUse -DaysToExpiration 30 ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateAuthority.md index 309f9190c..efea3e084 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateAuthority.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell PS C:\>Get-SPCertificateAuthority ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateNotificationContact.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateNotificationContact.md index a91ec2402..f14ba4e14 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateNotificationContact.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateNotificationContact.md @@ -24,7 +24,7 @@ The \`Get-SPCertificateNotificationContact\` cmdlet gets the email addresses to ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPCertificateNotificationContact -EmailAddress sharepoint-admins@example.com ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateSettings.md index bd362a6ea..d7f5cf37f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCertificateSettings.md @@ -27,7 +27,7 @@ These include default properties for creating and renewing certificates and cert ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPCertificateSettings ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProvider.md index f1128f7ff..e33785041 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a claim provider. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPClaimProvider -Identity "MyClaimProvider" | Set-SPClaimProvider -Enabled $false ``` @@ -39,6 +38,9 @@ This example disables the claim provider MyClaimProvider. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the claim provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProviderManager.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProviderManager.md index eaedd2545..4390047a3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProviderManager.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimProviderManager.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a claim provider manager. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------- +### EXAMPLE ```powershell Get-SPClaimProviderManager ``` @@ -38,6 +37,9 @@ This example returns a claim provider manager for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimTypeEncoding.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimTypeEncoding.md index a24709c29..bda0ee6e1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimTypeEncoding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPClaimTypeEncoding.md @@ -24,29 +24,26 @@ Get-SPClaimTypeEncoding [-AssignmentCollection ] [-Claim Use the Get-SPClaimTypeEncoding cmdlet to return the following: - -- A list of all the types of claims that are registered in the farm -- The Unicode character that will be encoded when the SPClaim.ToEncodedString method is invoked -- The SPClaim.ClaimType property is set to a valid value - For additional information about the SPClaim methods and properties, see M:Microsoft.SharePoint.Administration.Claims.SPClaim.ToEncodedString and P:Microsoft.SharePoint.Administration.Claims.SPClaim.ClaimType respectively. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1-------- +### EXAMPLE 1 ```powershell Get-SPClaimTypeEncoding ``` This example returns a list of all types of claima in the farm. -### --------------EXAMPLE 2-------- +### EXAMPLE 2 ```powershell Get-SPClaimTypeEncoding -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" ``` @@ -56,6 +53,9 @@ This example returns a specific claim type by using the ClaimType parameter. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -63,8 +63,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,13 +73,15 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies an encoding character that is mapped to a type of input claim. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,13 +91,15 @@ Accept wildcard characters: False ``` ### -EncodingCharacter + +> Applicable: SharePoint Server Subscription Edition + Specifies a type of claim that is mapped to an input character. ```yaml Type: Char Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPConnectedServiceApplicationInformation.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPConnectedServiceApplicationInformation.md index 6a17e5303..59ab1df98 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPConnectedServiceApplicationInformation.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPConnectedServiceApplicationInformation.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spconnectedserviceapplicationinformation -Applicable: SharePoint Server Subscription Edition + title: Get-SPConnectedServiceApplicationInformation schema: 2.0.0 --- @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $validProxy = $false $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq "User Profile Service Application Proxy"} @@ -44,6 +44,9 @@ This example checks the health of the service application proxy server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabase.md index 277e0bfb1..4a2612870 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns one or more content databases. - ## SYNTAX ### DefaultSet @@ -57,21 +56,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1------------ +### EXAMPLE 1 ```powershell Get-SPContentDatabase -WebApplication https://webAppUrl ``` This example returns all content databases used by the sitename Web application. -### ----------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell Get-SPContentDatabase -Site https://siteUrl ``` This example returns the content database that contains the site collection at https://siteUrl. -### ----------------EXAMPLE 3------------ +### EXAMPLE 3 ```powershell PS C:\>Get-SPContentDatabase -DaysSinceLastProfileSync 7 ``` @@ -80,6 +79,9 @@ This example returns all content databases that were last synchronized with the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a specific content database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -87,8 +89,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -98,6 +99,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Returns the content database for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -105,8 +109,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: ContentDatabasesOfSite -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -116,6 +119,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Returns the content databases for the specified Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -123,8 +129,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -141,8 +149,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,13 +159,15 @@ Accept wildcard characters: False ``` ### -ConnectAsUnattachedDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies that only unattached databases in the farm are returned. ```yaml Type: SwitchParameter Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -168,6 +177,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -175,8 +187,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -186,13 +197,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database in the farm. ```yaml Type: String Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database server in the farm. ```yaml Type: String Parameter Sets: Unattached -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -232,8 +247,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` - ### -NoStatusFilter + +> Applicable: SharePoint Server Subscription Edition + Specifies whether a status filter is turned on. The valid values are True or False. The default value is False. @@ -241,8 +258,7 @@ The valid values are True or False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: DefaultSet, AllContentDatabasesInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabaseOrphanedData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabaseOrphanedData.md index e2db1077b..c99bdd0fb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabaseOrphanedData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDatabaseOrphanedData.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spcontentdatabaseorphaneddata -Applicable: SharePoint Server Subscription Edition + title: Get-SPContentDatabaseOrphanedData schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Gets orphaned data in content database. - ## SYNTAX ``` @@ -20,13 +19,12 @@ Get-SPContentDatabaseOrphanedData [-Identity] [-AssignmentCollection ] [] ``` - ## DESCRIPTION Use the **Get-SPContentDatabaseOrphanedData** to display orphaned objects. ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Get-SPContentDatabase "WSS_Content" | Get-SPContentDatabaseOrphanedData ``` @@ -35,13 +33,16 @@ This example gets orphan objects in content database named "WSS_Content". ## PARAMETERS ### -Identity -Specifies the GUID of the content database to get. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the GUID of the content database to get. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: True Position: 1 Default value: None @@ -50,6 +51,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -62,7 +66,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -74,5 +78,4 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentJob.md index 11b471b19..c8e9a5719 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentJob.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Get-SPContentDeploymentJob -Identity 'Job 1' ``` @@ -38,6 +38,9 @@ This example returns the content deployment job called Job 1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment job to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -45,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies that content deployment jobs for only the specified content deployment path are returned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. @@ -85,8 +92,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentPath.md index 685a68610..8fba0b604 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPContentDeploymentPath.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ```powershell Get-SPContentDeploymentPath -Identity 'Path 1' ``` @@ -37,6 +37,9 @@ This example returns the content deployment path named Path 1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment path to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example, DeployPath1); or an instance of a valid SPContentDeploymentJob object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCustomLayoutsPage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCustomLayoutsPage.md index 64241dca8..7bff34159 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCustomLayoutsPage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPCustomLayoutsPage.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a mapping to a custom layout page. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPCustomLayoutsPage -Identity '_layouts/accessdenied.aspx' -WebApplication 'https://webAppUrl' ``` @@ -41,6 +40,9 @@ This example returns the mapping of the AccessDenied layout page in the Web appl ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web application that contains the custom layout page. The type must be a valid URL, in the form https://webAppUrl; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -48,8 +50,7 @@ The type must be a valid URL, in the form https://webAppUrl; a valid GUID, in th ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom layout page to get. The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. @@ -84,8 +90,7 @@ The type must be one of the following: None, AccessDenied, Confirmation, Error, ```yaml Type: SPCustomPage Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,13 +100,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFile.md index 1540de38c..eb7e3330f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFile.md @@ -27,21 +27,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ```powershell Get-SPDataConnectionFile ``` This example lists the Identity, DisplayName, and WebAccessible properties ofeach .udcx file. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell "Sample.udcx" | Get-SPDataConnectionFile ``` This example lists the Identity, DisplayName, and WebAccessible properties of the specified file, named Sample.udcx. -### ---------------EXAMPLE 3-------------- +### EXAMPLE 3 ```powershell Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} ``` @@ -51,6 +51,9 @@ This example lists the Identity, DisplayName, and WebAccessible properties of al ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the data file connection to get. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -58,8 +61,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFileDependent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFileDependent.md index b3b5ad221..9d108d9df 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFileDependent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDataConnectionFileDependent.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPDataConnectionFileDependant -Identity 'FileName.udcx' ``` @@ -36,6 +36,9 @@ This example displays a list of deployed forms with a specified name. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the data connection file to get. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -43,8 +46,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -61,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDatabase.md index cca1bd69a..0aa3f7ebe 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves all properties of a database. - ## SYNTAX ### DefaultParameterSet @@ -46,14 +45,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Get-SPDatabase | ?{$_.TypeName -eq 'Microsoft.Office.Server.Administration.ProfileDatabase'} ``` This example gets the Profile database used by the User Profile Service Application. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Get-SPDatabase -Name 'Profile DB' ``` @@ -63,6 +62,9 @@ This example gets the Profile database by name. Applies to SharePoint Server 201 ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to display public properties. The type must be a valid GUID, in the form 1234-3456-567kg. @@ -70,8 +72,7 @@ The type must be a valid GUID, in the form 1234-3456-567kg. ```yaml Type: SPDatabasePipeBind Parameter Sets: DefaultParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the SQL instance that contains the database in either the form "Server" for a default SQL instance or "Server\Instance" for a named SQL instance. ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: ServerParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -104,8 +110,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database. ```yaml Type: String Parameter Sets: NameParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDeletedSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDeletedSite.md index 8445adc5a..aef6481e4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDeletedSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDeletedSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Gets a list of deleted site collections. - ## SYNTAX ``` @@ -43,21 +42,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Get-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c ``` This example gets a specific deleted site collection by using a site ID. -### ------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Get-SPDeletedSite "/" ``` This example gets a deleted site collection from the root site. -### ------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Get-SPDeletedSite '/Site/cat*' ``` @@ -68,6 +67,9 @@ The asterisk (*) wildcard character requests a match for multiple characters. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to get. The identity can be either a valid server-relative URL in the form /sites/site_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -75,8 +77,7 @@ The identity can be either a valid server-relative URL in the form /sites/site_n ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +101,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -132,8 +140,7 @@ The type must be a valid database name in the form SPContentDB01 or a valid GUID ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,13 +150,15 @@ Accept wildcard characters: False ``` ### -DateTimeFrom + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -DateTimeTo + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Limits the maximum number of site collections to return. The default value is 1000. @@ -184,8 +198,7 @@ Specify ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -195,6 +208,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription from which to get site collections. The type must be a valid URL in the form https://server_name or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -202,8 +218,7 @@ The type must be a valid URL in the form https://server_name or a valid GUID, fo ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -220,8 +238,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -231,6 +248,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -238,7 +258,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDesignerSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDesignerSettings.md index a804d02b1..f8a468db2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDesignerSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDesignerSettings.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays SharePoint Designer features. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE------------------------ +### EXAMPLE ```powershell Get-SPDesignerSettings -webapplication https://contoso ``` @@ -39,13 +38,15 @@ This example retrieves the SharePoint Designer settings for the Web application, ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application in which the settings apply. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticConfig.md index 1514da468..9635cda85 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves ULS diagnostic configuration values of the farm. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPDiagnosticConfig ``` @@ -38,6 +37,9 @@ This example returns all diagnostic configuration values. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsPerformanceCounter.md index c09cedfa4..1ac253d15 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsPerformanceCounter.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a collection of performance counters. - ## SYNTAX ``` @@ -35,21 +34,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPDiagnosticsPerformanceCounter ``` This example gets the performance counter settings for front end Web servers and database servers. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPDiagnosticsPerformanceCounter -WebFrontEnd ``` This example gets the performance counter settings for front end Web servers. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Get-SPDiagnosticsPerformanceCounter -DatabaseServer ``` @@ -59,6 +58,9 @@ This example gets the performance counter settings for database servers. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +68,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Returns performance counters collected for the database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server Subscription Edition + Returns performance counters collected for the front end Web servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsProvider.md index ba32513c0..3c3ff8b37 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDiagnosticsProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a diagnostics provider. - ## SYNTAX ``` @@ -30,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPDiagnosticsProvider ``` This example returns all the diagnostics providers in the farm. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPDiagnosticsProvider job-diagnostics-event-log-provider ``` @@ -47,6 +46,9 @@ This example returns the event log diagnostics provider. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the diagnostics provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticsProv1); or an instance of a valid SPDiagnosticsProvider object. @@ -54,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPDiagnosticsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDistributedCacheClientSetting.md index 891e8dcfc..db5bd6f62 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDistributedCacheClientSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPDistributedCacheClientSetting.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns distributed cache settings from usage. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE-------- +### EXAMPLE ```powershell Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache ``` @@ -41,6 +40,8 @@ This example returns the Distributed Cache client settings for DistributedLogonT ### -ContainerType +> Applicable: SharePoint Server Subscription Edition + Specifies the container type to clear. The valid values are the following: @@ -66,12 +67,10 @@ The valid values are the following: -DistributedViewStateCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -81,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchAdministrationComponent.md index fd029a54b..4f8a64126 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchAdministrationComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchAdministrationComponent.md @@ -26,7 +26,7 @@ For permissions and the most current information about search cmdlets, see the o ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa @@ -37,6 +37,9 @@ This example obtains an object reference to the administration component of a se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -44,8 +47,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the administration component. The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication object. @@ -62,8 +67,7 @@ The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890 ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchComponent.md index 71c46d58b..db558d2b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchComponent.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves one or all search components in a given search topology. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -Identity '06e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa @@ -39,7 +38,7 @@ Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b61 This example retrieves the search component with the identity 06e6651d-ecdd-4105-bb65-6a83b6155525 from the search topology with identity 56e6651d-ecdd-4105-bb65-6a83b6155525 in the search service application referenced by $ssa. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchComponent -SearchTopology '56e6651d-ecdd-4105-bb65-6a83b6155525' -SearchApplication $ssa @@ -50,13 +49,15 @@ This example retrieves all search components from the search topology with the i ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity for a search component. ```yaml Type: SearchComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology from which to retrieve the search component/search components. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -89,8 +95,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology and search component/search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md index 1d4c5ef31..57adb464f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the content enrichment configuration for the specified search service application. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa @@ -40,13 +39,15 @@ This example retrieves the ContentEnrichmentConfiguration object from the defaul ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -63,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlContentSource.md index 2e0f456e4..cdb9e4732 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlContentSource.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Identity 'Local SharePoint Sites' @@ -40,6 +40,9 @@ This example retrieves the default content source for the search service applica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content source to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +90,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlCustomConnector.md index 69424899f..55d050968 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlCustomConnector.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE---------------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -Protocol 'http://' @@ -38,13 +38,15 @@ This example obtains a reference to all custom crawl connectors for the http:// ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Search application with which the CustomConnector objects are associated. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -61,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: SharePoint Server Subscription Edition + Specifies the string version of the protocol for which to return the CustomConnector object, for example, "dctm://" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlDatabase.md index 9b8a31b28..e68b9c716 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlDatabase.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE------------------- +### EXAMPLE ```powershell Get-SPEnterpriseSearchCrawlDatabase -SearchApplication 'Search Service Application' -Identity CrawlDB_1 ``` @@ -40,6 +40,9 @@ This example gets a reference to the crawl database CrawlDB_1 from the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a CrawlStore object, in the form CrawlStore1; or an instance of a valid CrawlStore object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +90,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlExtension.md index 93c0fe3b3..299d6aacb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlExtension.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### Add code example. +### Add code example. ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlExtension -Identity 'pdf' -SearchApplication $ssa @@ -41,6 +41,9 @@ This example checks whether the pdf file type is included in the file types to b ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extension to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ExtensionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the extension collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -84,8 +91,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlLogReadPermission.md index 2083384d6..11dd8d283 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlLogReadPermission.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant '00000000-0000-0000-0000-000000000001' @@ -40,14 +40,16 @@ This example retrieves a list of users who have permission to view the crawl log ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application for which to list crawl log permissions. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,14 +79,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the list of users shall be within the scope of this tenant. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlMapping.md index f384d255e..99c1e9c0f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlMapping.md @@ -41,6 +41,9 @@ This example returns the crawl mappings for the search application 'Search Servi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl mapping to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://crawlmap1; or an instance of a valid CrawlMapping object. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: CrawlMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -84,8 +91,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlRule.md index 440c9dfcc..802d6cedb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchCrawlRule.md @@ -27,15 +27,15 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell -$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' +$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Identity https://webAppUrl ``` This example uses the `Get-SPEnterpriseSearchCrawlRule` cmdlet to retrieve a crawl rule. -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchCrawlRule -SearchApplication $searchApp | ?{$_.Path -like '*example*'} @@ -46,6 +46,9 @@ This example returns a list of crawl rules with paths that contain the word exam ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search crawl rule path. A valid URL, such as "https://webAppUrl", or an instance of a valid CrawlRule object @@ -53,8 +56,7 @@ A valid URL, such as "https://webAppUrl", or an instance of a valid CrawlRule ob ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -64,6 +66,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl rule. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object @@ -71,8 +76,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -89,8 +96,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchFileFormat.md index 75a471a9e..bbe7e06ee 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchFileFormat.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves all parseable file formats. - ## SYNTAX ``` @@ -31,10 +30,9 @@ If no format ID is provided, the cmdlet returns all the parseable file formats. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa @@ -42,7 +40,7 @@ Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa This example uses the Get-SPEnterpriseSearchFileFormat to retrieve all parseable file formats in the search service application referenced by $ssa. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity DOCX @@ -53,13 +51,15 @@ This example uses the Get-SPEnterpriseSearchFileFormat cmdlet to retrieve inform ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the format ID for which to retrieve file format information. ```yaml Type: DocumentParserFileFormatPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -70,6 +70,8 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search application for which to retrieve file format information. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -77,8 +79,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -95,8 +99,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchHostController.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchHostController.md index 155dbd4f3..df87f41de 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchHostController.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchHostController.md @@ -28,14 +28,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPEnterpriseSearchHostController ``` This example retrieves a list of all HostControllers in the farm with their status (primary/secondary) and repository version. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssi = Get-SPEnterpriseSearchServiceInstance -Local Get-SPEnterpriseSearchHostController -SearchServiceInstance $ssi @@ -46,6 +46,9 @@ This example retrieves the status information for the SearchHostController on th ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -53,8 +56,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -SearchServiceInstance + +> Applicable: SharePoint Server Subscription Edition + The Search Service instance of the server from where the SearchHostController object is returned. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLanguageResourcePhrase.md index 4c7661edb..473489e00 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLanguageResourcePhrase.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application' Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language 'en-us' -Type QuerySuggestionBlockList @@ -40,6 +40,8 @@ This example returns all language resource entries for the en-us language in the ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,12 +51,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -65,17 +65,17 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Server Subscription Edition + Specifies the language resource phrase to get. The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - ```yaml Type: LanguageResourcePhrasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -86,17 +86,17 @@ Accept wildcard characters: False ### -Language +> Applicable: SharePoint Server Subscription Edition + Filters to return phrases of a specified source language. The type must be a valid name of a language; for example, en-us or ja-jp. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,18 +107,18 @@ Accept wildcard characters: False ### -Mapping +> Applicable: SharePoint Server Subscription Edition + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +129,8 @@ Accept wildcard characters: False ### -Owner +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -139,12 +141,10 @@ The owner must be one of the following valid levels: - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -155,17 +155,17 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -176,15 +176,15 @@ Accept wildcard characters: False ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server Subscription Edition +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -195,6 +195,8 @@ Accept wildcard characters: False ### -Type +> Applicable: SharePoint Server Subscription Edition + Filters to return phrases of a specified type. The type must be one of the following valid types of phrases: @@ -205,12 +207,10 @@ The type must be one of the following valid types of phrases: - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinguisticComponentsStatus.md index 37a7e092a..6c8d4ca14 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinguisticComponentsStatus.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinguisticComponentsStatus.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa @@ -38,13 +38,15 @@ This example gets the current status of the linguistic query and document proces ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + An object that represents the current status of the linguistic components. ```yaml Type: LinguisticComponentsStatusPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the linguistic processing components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -77,8 +84,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinksDatabase.md index aebc26c19..99c57b7cc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchLinksDatabase.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------EXAMPLE--------- +### EXAMPLE ```powershell Get-SPEnterpriseSearchLinksDatabase -Identity LinksDB_1 -SearchApplication 'Search Service Application' ``` @@ -39,6 +39,9 @@ This example gets a reference to the links database LinksDB_1 from the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the links database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -64,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -82,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCategory.md index 2e21a2f9e..f489fff08 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCategory.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa @@ -42,6 +42,9 @@ This example retrieves the metadata category collection of a search service appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata category to retrieve. The type must a valid search application name, for example, MetadataCategory1, or an instance of a valid Category object. @@ -49,8 +52,7 @@ The type must a valid search application name, for example, MetadataCategory1, o ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the enterprise search metadata categories. The type must a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -67,8 +72,7 @@ The type must a valid search application name, for example, SearchApp1, or an in ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -85,8 +92,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata categories returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -103,8 +112,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata categories returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -121,8 +132,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCrawledProperty.md index 8019d9557..5ae67aa64 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataCrawledProperty.md @@ -54,6 +54,8 @@ This example returns the mappings of a specific crawled property in the PeopleSe ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -61,8 +63,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,6 +74,8 @@ Accept wildcard characters: False ### -Category +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata category of the crawled property to return. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. @@ -81,7 +84,6 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, Type: CategoryPipeBind Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -92,6 +94,8 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of items to return. Specify ALL to return all possible results. @@ -99,8 +103,7 @@ Specify ALL to return all possible results. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +114,8 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Server Subscription Edition + Specifies the crawled property to retrieve. The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" @@ -118,8 +123,7 @@ The type must be a valid crawled property name, for example "urn:schemas-microso ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +134,8 @@ Accept wildcard characters: False ### -PropSet +> Applicable: SharePoint Server Subscription Edition + Specifies to return crawled properties that use the specified property set. A property set belongs to one crawled property category. @@ -139,7 +145,6 @@ The type must be a valid GUID that specifies the property set in the form 123456 Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -150,6 +155,8 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawled property. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -157,8 +164,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -169,6 +175,8 @@ Accept wildcard characters: False ### -SiteCollection +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -176,8 +184,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,6 +195,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -195,8 +204,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -207,17 +215,17 @@ Accept wildcard characters: False ### -VariantType +> Applicable: SharePoint Server Subscription Edition + Specifies to return crawled properties that use the specified variant type. The type must be an integer that specifies the variant data type of the property set. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: vt -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataManagedProperty.md index 63c0d0c67..4bdee098e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataManagedProperty.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -40,6 +40,9 @@ This example retrieves the managed property UserName from the default search ser ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to retrieve. The type must be a valid name of metadata property, for example MetadataProperty1, or an instance of a valid ManagedProperty object. @@ -47,8 +50,7 @@ The type must be a valid name of metadata property, for example MetadataProperty ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +90,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,14 +100,16 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of managed properties to return. Specify ALL to return all possible results. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -118,8 +129,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +139,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -136,8 +149,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataMapping.md index 940da8f67..ed430977d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchMetadataMapping.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -40,6 +40,9 @@ This example lists all crawled properties mapped to the managed property UserNam ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the metadata mapping. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -47,8 +50,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -65,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -CrawledProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawled property from which to return mappings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -83,8 +90,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property from which to return mappings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -101,8 +110,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -119,8 +130,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +140,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mappings returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -137,8 +150,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchOwner.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchOwner.md index 8aec982a2..81fcd3b56 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchOwner.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchOwner.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell Get-SPEnterpriseSearchOwner -Level SPSite ``` @@ -37,13 +37,15 @@ This example shows how to retrieve the tenant owner of a search object at the SP ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner to retrieve. ```yaml Type: SearchObjectOwner Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the owner object resides at the SPWeb, SPSite, SPSite Subscription, or SSA level. ```yaml Type: SearchObjectLevel Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -69,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +87,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,14 +97,16 @@ Accept wildcard characters: False ``` ### -SPWeb + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWeb or SPSite in which this object resides. It is only needed if Level is equal to SPWeb or SPSite. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRule.md index cf80d4421..7cb45650d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRule.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -41,13 +41,15 @@ The second step specifies the value that the property shall start with. ## PARAMETERS ### -PropertyName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the property that the rule concerns. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Operator + +> Applicable: SharePoint Server Subscription Edition + Specifies the operation to apply to the property, for example "Starts with". ```yaml Type: DefaultOperator Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -80,8 +87,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRuleCollection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRuleCollection.md index ee8aa1f8b..8612a9269 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRuleCollection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchPropertyRuleCollection.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName 'ContentTypeId' -Operator 'StartsWith' $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -42,6 +42,9 @@ Thereafter the example returns the rule collection, and adds the rule to the rul ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +52,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md index d32206de4..d63849f61 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsService.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $qssService = Get-SPEnterpriseSearchQUeryAndSiteSettingsService ``` @@ -37,6 +37,9 @@ This example obtains a reference to the query and site settings service. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index d718b176f..c77edf8c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $qqssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local ``` This example obtain a reference to the query and site setting service instance on the local farm. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $qssSvcInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity myServer ``` @@ -44,6 +44,9 @@ This example obtain a reference to the query and site setting service instance f ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search manager service instance to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid server name on which search manager service instance runs; or an instance of a valid SearchManagerServiceInstance object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service manager service instance for the current search server is returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md index 05cc9d4f9..8ae631d88 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $qssSvcProxy = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy ``` @@ -36,6 +36,9 @@ This example obtains a reference to the query and site settings service proxy. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,8 +50,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAuthority.md index 95aa8698e..90a3c1e1f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryAuthority.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' Get-SPEnterpriseSearchQueryAuthority -Identity 'https://contoso.com' -SearchApplication $ssa @@ -37,7 +37,7 @@ Get-SPEnterpriseSearchQueryAuthority -Identity 'https://contoso.com' -SearchAppl This example obtains the authoritative page for the URL https://contoso.com from the search service application named 'Search Service Application'. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPEnterpriseSearchQueryAuthority -SearchApplication 'Search Service Application' ``` @@ -47,6 +47,9 @@ This example obtains the collection of query authority pages from a search servi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the query authority to get. The type must be a valid URL, in the form https://server_name; or an instance of a valid AuthorityPage object. @@ -54,8 +57,7 @@ The type must be a valid URL, in the form https://server_name; or an instance of ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the authority page to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -88,8 +95,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +119,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryDemoted.md index d0ba1cdf6..c379124c8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryDemoted.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity https://somesite.com -SearchApplication 'Search Service Application' Remove-SPEnterpriseSearchQueryDemoted -Identity $demotedRule -SearchApplication 'Search Service Application' @@ -40,6 +40,9 @@ This example obtains a reference to a site demotion rule for the URL https://som ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the demoted site rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance a valid Demoted object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: DemotedPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the demoted site rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -81,8 +88,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -92,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -99,8 +108,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryKeyword.md index 22d1c1f09..5a550eaa0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryKeyword.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site https://myserver/sites/engineering ``` @@ -41,6 +41,9 @@ This example gets a reference to the keyword with the term Engineering from the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the keyword term to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. @@ -48,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Filters to return keywords with the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScope.md index d9b9e95e2..8d1ae5840 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScope.md @@ -39,7 +39,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPenterpriseSearchServiceApplication -Identity 'Search service Application' Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage https://altServer @@ -50,6 +50,9 @@ This example obtains a reference to the scope named MustCrawl on the search appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the results scope to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -57,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -68,6 +70,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -75,8 +80,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -93,8 +100,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Filters to return scopes for the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -112,7 +121,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScopeRule.md index 31982b89d..0dc7a79ef 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQueryScopeRule.md @@ -38,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -50,6 +50,9 @@ This example gets a reference to a scope rule for the URL https://criticalSite, ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. @@ -57,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -68,6 +70,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Returns query scope rules for the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -76,7 +81,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid URL, in the form https://server_name. Returns query scope rules for the specified results URL. @@ -93,8 +100,7 @@ Returns query scope rules for the specified results URL. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -111,8 +120,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +130,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -129,8 +140,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySpellingCorrection.md index 65da25380..508f62805 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySpellingCorrection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySpellingCorrection.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchQuerySpellingCorrection -SearchApplication $ssa @@ -38,13 +38,15 @@ Returns the current configuration for the Query Spelling Correction component fo ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies an object that represents the current status for the query spelling correction. ```yaml Type: QuerySpellingCorrectionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -55,13 +57,14 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the query spelling correction parameters. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -78,8 +84,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySuggestionCandidates.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySuggestionCandidates.md index df2c473a7..a30e4fecc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySuggestionCandidates.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchQuerySuggestionCandidates.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE------------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchQuerySuggestionCandidates -SearchApplication $ssa @@ -39,6 +39,9 @@ This example returns popular search queries by using the search application cont ## PARAMETERS ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -52,7 +55,6 @@ The owner must be one of the following valid levels: Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -87,8 +94,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -SourceId + +> Applicable: SharePoint Server Subscription Edition + Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchRankingModel.md index c751b8a46..ca19b42d0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchRankingModel.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -38,7 +38,7 @@ Get-SPEnterpriseSearchRankingModel -Identity '8f6fd0bc-06f9-43cf-bbab-08c377e083 This example retrieves the ranking model on the search service application level with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 for the search application Search Service Application. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -50,6 +50,9 @@ This example retrieves all ranking models defined on the search service applicat ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ranking model to retrieve. The type must be a valid GUID in the form 8f6fd0bc-06f9-43cf-bbab-08c377e083f4, or an instance of a valid RankingModel object. @@ -57,8 +60,7 @@ The type must be a valid GUID in the form 8f6fd0bc-06f9-43cf-bbab-08c377e083f4, ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -68,6 +70,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -76,7 +81,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the ranking model. The type must be a valid GUID in the form 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -93,8 +100,7 @@ The type must be a valid GUID in the form 9bf36458-fc99-4f7b-b060-867e5a63adce, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -111,8 +120,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultItemType.md index 05dc36f56..22002d380 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultItemType.md @@ -26,7 +26,7 @@ The Get-SPEnterpriseSearchResultItemType cmdlet retrieves the result item types Result item types enable you to change the look of search results based on the type of result. You start by defining a collection of rules, which will be evaluated against the properties of results. -Then you define the display template to use for rendering that type of result. +Then you define the display template to use for rendering that type of result. Once you have created the result item type, results matching the rules of the result item type will render using the specified display template. Example use cases: @@ -39,10 +39,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite @@ -56,6 +55,9 @@ Although SearchApplication and SearchApplicationProxy are optional parameters, t ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -63,8 +65,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -97,8 +103,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -115,8 +123,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -133,8 +143,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultSource.md index 204d00f9c..740bfcedb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchResultSource.md @@ -27,10 +27,9 @@ This cmdlet retrieves a result source object. If the Identity parameter is not specified, this cmdlet returns the result source collection for the specified search object owner. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831] (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -------------- Example 1: Get result source by name -------------- +### -------------- Example 1: Get result source by name -------------- ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -39,8 +38,7 @@ Get-SPEnterpriseSearchResultSource -Identity "Local SharePoint Results" -SearchA This example retrieves the search service application level result source with the name "Local SharePoint Results". - -### -------------- Example 2: Get result source by id -------------- +### -------------- Example 2: Get result source by id -------------- ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -49,7 +47,7 @@ Get-SPEnterpriseSearchResultSource -Identity 8413cd39-2156-4e00-b54d-11efd9abdB8 This example retrieves the search service application level result source with the id 8413cd39-2156-4e00-b54d-11efd9abdB89. -### -------------- Example 3: Get all result sources under SSA -------------- +### -------------- Example 3: Get all result sources under SSA -------------- ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -61,6 +59,9 @@ This example retrieves all the search service application level result sources. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result source to retrieve. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Local SharePoint Results"); or an instance of a valid Source object. @@ -70,8 +71,7 @@ If not specified, the result source collection for the specified search object o ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -81,13 +81,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -97,6 +99,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -104,8 +109,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -116,6 +120,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -123,8 +129,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSecurityTrimmer.md index 5ba63cb41..73f65bb21 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSecurityTrimmer.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa @@ -41,6 +41,9 @@ This example obtains the pluggable security trimmers registered in the search se ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the pluggable security trimmer used for the specified search application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. @@ -48,8 +51,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SecurityTrimmerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the security trimmer. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -84,8 +91,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchService.md index a7f42baa2..740236da5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchService.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchService ``` @@ -35,6 +35,9 @@ This example obtains a reference to the search service of the current farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -42,8 +45,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplication.md index 18cfb88c6..0046c39a3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplication.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application' ``` @@ -36,6 +36,9 @@ This example obtains a reference to a search service application named 'Search S ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to retrieve. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. @@ -43,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -61,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationBackupStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationBackupStore.md index e375db80c..ff38c94b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationBackupStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationBackupStore.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves information about the search service application backup files. - ## SYNTAX ``` @@ -30,17 +29,16 @@ This cmdlet returns information about the search databases and index files in a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -BackupId 3222ad97-91ad-471f-a764-780ec1f05f74 ``` This example retrieves the backup of the search databases and index files that are located at \\\\sample\backup with the backup id 3222ad97-91ad-471f-a764-780ec1f05f74 from the search service application Search Service Application. -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPEnterpriseSearchServiceApplicationBackupStore -BackupFolder \\sample\backup -Name "Search Service Application" -UseMostRecent ``` @@ -50,13 +48,15 @@ This example retrieves the most recently taken backup of the search databases an ## PARAMETERS ### -BackupFolder + +> Applicable: SharePoint Server Subscription Edition + Specifies the full file path of the backup files. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,15 +67,15 @@ Accept wildcard characters: False ### -Name -Specifies the name of the search service application from which to retrieve the related backup information. +> Applicable: SharePoint Server Subscription Edition +Specifies the name of the search service application from which to retrieve the related backup information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -85,13 +85,15 @@ Accept wildcard characters: False ``` ### -BackupId + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the backup in the referred package. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -101,13 +103,15 @@ Accept wildcard characters: False ``` ### -UseMostRecent + +> Applicable: SharePoint Server Subscription Edition + A switch to specify if the most recent backup should be used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 5 @@ -117,13 +121,15 @@ Accept wildcard characters: False ``` ### -IsVerbose + +> Applicable: SharePoint Server Subscription Edition + A switch to specify if messages should be printed out when the cmdlet is running. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 6 @@ -133,6 +139,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -144,8 +153,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +163,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -172,6 +182,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +192,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationProxy.md index d24fa2427..dc8195f7a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceApplicationProxy.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $proxy = Get-SPEnterpriseSearchServiceApplicationProxy -Identity 'Search Service Application Proxy' ``` @@ -37,6 +37,9 @@ This example obtains a reference to a search service application proxy with the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application proxy to retrieve. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceInstance.md index 54868c9b1..8ae58f5e5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchServiceInstance.md @@ -26,14 +26,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPEnterpriseSearchServiceInstance -Local ``` This example obtains a reference to the local search service instance. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPEnterpriseSearchServiceInstance | ?{$_.Server -match 'SP01'} ``` @@ -43,6 +43,9 @@ This example obtains a reference to the search service instance on the SharePoin ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance to return. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -68,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +83,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Returns the search service instance for the current search server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSiteHitRule.md index af91dad40..e5fe0906d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchSiteHitRule.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $shRule = Get-SPEnterpriseSearchSiteHitRule -Identity MySiteHitRule ``` @@ -39,6 +39,9 @@ The following example obtains a reference to the site hit rule with the name MyS ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site hit rule to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SiteHitRule object. @@ -46,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SiteHitRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service that hosts the crawler with the specified shared site search rules. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -64,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchStatus.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchStatus.md index b4d59f81c..8dab821a2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchStatus.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchStatus.md @@ -41,7 +41,7 @@ You can use the cmdlet to output the following additional information: - List detailed diagnostic information for the index component - Debug information that may be used by Microsoft for detailed issue resolution -If you don't want to iterate over the output in a script, use the Text parameter. +If you don't want to iterate over the output in a script, use the Text parameter. If you do not use the Text parameter, the cmdlet will output a set of objects that have the following properties: - string Name: the name of a search component, a health report item or a constellation property @@ -52,24 +52,23 @@ If you do not use the Text parameter, the cmdlet will output a set of objects th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -Text ``` This example retrieves a list that has diagnostics information about all search components of the default Search Service Application. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPEnterpriseSearchStatus -SearchApplication 'Search Service Application' -JobStatus -Text ``` This example retrieves the background activity job status for the search analytics timer jobs. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Get-SPEnterpriseSearchServiceApplication | Get-SPEnterpriseSearchStatus -HealthReport -Component IndexComponent1 -Text ``` @@ -79,13 +78,15 @@ This example retrieves the diagnostic information for the index component named ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -95,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -102,8 +106,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,16 +117,16 @@ Accept wildcard characters: False ### -Component -Specifies the name of the search component. -This parameter is only used in association with the HealthReport and Primary parameter. +> Applicable: SharePoint Server Subscription Edition +Specifies the name of the search component. +This parameter is only used in association with the HealthReport and Primary parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,16 +137,16 @@ Accept wildcard characters: False ### -Constellation -Specifies if internal diagnostic information for the search topology should be provided. -This parameter should only be used for debugging. +> Applicable: SharePoint Server Subscription Edition +Specifies if internal diagnostic information for the search topology should be provided. +This parameter should only be used for debugging. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,14 +156,16 @@ Accept wildcard characters: False ``` ### -Detailed + +> Applicable: SharePoint Server Subscription Edition + Specifies the level of detail for the HealthReport parameter. When this parameter is used, the cmdlet will also output verbose diagnostic information. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,16 +176,16 @@ Accept wildcard characters: False ### -DetailSearchRuntime -Specifies if internal diagnostic information for the search runtime should be provided. -This parameter should only be used for debugging. +> Applicable: SharePoint Server Subscription Edition +Specifies if internal diagnostic information for the search runtime should be provided. +This parameter should only be used for debugging. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,16 +196,16 @@ Accept wildcard characters: False ### -HealthReport -Specifies if diagnostic information for the search component should be provided. -When using this parameter, you must specify the component name using the Component parameter. +> Applicable: SharePoint Server Subscription Edition +Specifies if diagnostic information for the search component should be provided. +When using this parameter, you must specify the component name using the Component parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -210,13 +215,15 @@ Accept wildcard characters: False ``` ### -JobStatus + +> Applicable: SharePoint Server Subscription Edition + Specifies if status information for the Search Analytics and Usage Analytics timer jobs should be provided. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,17 +234,17 @@ Accept wildcard characters: False ### -Primary +> Applicable: SharePoint Server Subscription Edition + Specifies if the Admin component has the Primary role. -When using this parameter, you must specify the component name using the Component parameter. +When using this parameter, you must specify the component name using the Component parameter. Returns true if the Admin Component has the Primary role. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -248,18 +255,18 @@ Accept wildcard characters: False ### -Text -Specifies if the print output from this cmdlet should be outputted in a format that is convenient for reading. +> Applicable: SharePoint Server Subscription Edition + +Specifies if the print output from this cmdlet should be outputted in a format that is convenient for reading. If not used, this cmdlet outputs a SearchStatusInfo object. When using this parameter, the output is printed to the console and cannot be piped to a file or another program. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchTopology.md index 788242656..9f07ac0e1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchTopology.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -35,7 +35,7 @@ Get-SPEnterpriseSearchTopology -SearchApplication $ssa This example retrieves all search topologies of the search service application referenced by $ssa. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Active @@ -43,7 +43,7 @@ Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Active This example retrieves the active search topology of the search service application referenced by $ssa. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity '10fa59cb-4b32-4fe6-8f8d-065388df201e' @@ -54,13 +54,15 @@ This example retrieves search topology with the identity 10fa59cb-4b32-4fe6-8f8d ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology to retrieve. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -70,6 +72,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which the search topology belongs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -77,8 +82,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,13 +92,15 @@ Accept wildcard characters: False ``` ### -Active + +> Applicable: SharePoint Server Subscription Edition + Specifies that the active search topology should be returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,14 +110,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchVssDataPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchVssDataPath.md index c99b5ba32..131e44384 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchVssDataPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPEnterpriseSearchVssDataPath.md @@ -20,17 +20,16 @@ Get-SPEnterpriseSearchVssDataPath [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md index be6adc9ec..dc4ca302a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the local SharePoint farm. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### +### ```powershell $f = Get-SPFarm ``` @@ -39,6 +38,9 @@ This example stores the local farm in a variable. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarmConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarmConfig.md index 911c310a8..3178a87b9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarmConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarmConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a global property or a collection of global properties for the local farm. - ## SYNTAX ``` @@ -24,7 +23,7 @@ Get-SPFarmConfig [-AssignmentCollection ] [-ServiceConne ## DESCRIPTION The Get-SPFarmConfig cmdlet retrieves global settings for the local farm that are not members of the SPFarm object. -This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. +This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. The PSCustomObject object can be read, or modified and passed to the Set-SPFarmConfig cmdlet to change parameter values. @@ -36,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------------- +### EXAMPLE ```powershell $a = Get-SPFarmConfig $a.AjaxTimeout = 200 @@ -48,6 +47,9 @@ This example uses the Get-SPFarmConfig cmdlet to add the Ajax Timeout setting to ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -55,8 +57,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -66,13 +67,15 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPoint + +> Applicable: SharePoint Server Subscription Edition + Gets the information stored in the current farm's service connection point in Active Directory. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFeature.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFeature.md index de5190358..8a7334a35 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFeature.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFeature.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the SharePoint Features based on a given scope. - ## SYNTAX ### FarmFeatures @@ -65,13 +64,13 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPFeature -Limit ALL | Where-Object {$_.Scope -eq "SITE"} ``` This example returns a list of all installed SITE scoped Features. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPSite https://somesite | Get-SPWeb -Limit ALL |%{ Get-SPFeature -Web $_ } | Select DisplayName,ID -Unique ``` @@ -81,6 +80,9 @@ This example returns the name and identifier (ID) of each uniquely enabled Featu ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Feature to retrieve. The type must be the full or partial name, in the form Feature1, or a GUID, in the form 1234-4567-9879, of the Feature to get. @@ -88,8 +90,7 @@ The type must be the full or partial name, in the form Feature1, or a GUID, in ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -99,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -106,8 +110,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,13 +120,15 @@ Accept wildcard characters: False ``` ### -Farm + +> Applicable: SharePoint Server Subscription Edition + Specifies that if this parameter is used, only enabled farm Features are displayed. ```yaml Type: SwitchParameter Parameter Sets: FarmFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,6 +138,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Limits the display results. If "All" is specified, all Features are displayed. The type must be a valid number greater than 0. The default value is 200. @@ -140,8 +148,7 @@ The type must be a valid number greater than 0. The default value is 200. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the site collection from which to get enabled Features. The type must be a valid URL for a site collection, in the form https://server_name . @@ -158,8 +168,7 @@ The type must be a valid URL for a site collection, in the form https://server_n ```yaml Type: SPSitePipeBind Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +178,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the Web. The type must be a valid URL, in the form https://server_name , or a GUID, in the form 1234-5678-9876-0987. @@ -176,8 +188,7 @@ The type must be a valid URL, in the form https://server_name , or a GUID, in t ```yaml Type: SPWebPipeBind Parameter Sets: WebFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -187,6 +198,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Web application from which to get enabled Features. The type must be a valid URL to the Web application in the form https://server_name . @@ -194,8 +208,7 @@ The type must be a valid URL to the Web application in the form https://server_n ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplicationFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,13 +218,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: FarmFeatureDefinitions -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,13 +236,15 @@ Accept wildcard characters: False ``` ### -Sandboxed + +> Applicable: SharePoint Server Subscription Edition + Specifies to retrieve Sandbox features. ```yaml Type: SwitchParameter Parameter Sets: SiteFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFlightsInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFlightsInfo.md index f2ed33433..06d53981a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFlightsInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFlightsInfo.md @@ -24,7 +24,7 @@ Use the Get-SPFlightsInfo cmdlet to get the current enabled flights info in the ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPFlightsInfo ``` @@ -34,6 +34,9 @@ This example gets the whole current enabled flights info in the current farm.. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -FlightId + +> Applicable: SharePoint Server Subscription Edition + Enter the specific flight Id. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -95,7 +104,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHealthAnalysisRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHealthAnalysisRule.md index 5ca7ff3b9..df8205125 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHealthAnalysisRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHealthAnalysisRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Gets a health analyzer rule. - ## SYNTAX ``` @@ -39,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE 1--------------------------- +### EXAMPLE 1 ```powershell Get-SPHealthAnalysisRule -Identity "CustomRule" ``` @@ -49,6 +48,9 @@ This example returns the health analyzer rule named CustomRule. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or GUID of the health analyzer rule to get. The type must be a valid name, an instance of a valid SPHealthAnalysisRule object, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -56,8 +58,7 @@ The type must be a valid name, an instance of a valid SPHealthAnalysisRule objec ```yaml Type: SPHealthAnalysisRuleInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHelpCollection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHelpCollection.md index 49997b864..ddd56faa4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHelpCollection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPHelpCollection.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns Help collection files. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPHelpCollection ``` @@ -39,6 +38,9 @@ This example gets all installed Help collection files. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Help collection files to get. The type must be a valid name of a Help collection folder; for example, HelpDocs1. @@ -68,8 +72,7 @@ The type must be a valid name of a Help collection folder; for example, HelpDocs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPIRMSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPIRMSettings.md index 35992ea11..18f62b943 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPIRMSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPIRMSettings.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE---------------- +### EXAMPLE ```powershell Get-SPIRMSettings ``` @@ -38,6 +37,9 @@ This example returns IRM settings for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormTemplate.md index f937bbf1e..39a4dcf7f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormTemplate.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ```powershell Get-SPInfoPathFormTemplate ``` This example lists the Identity, DisplayName, and FormTemplateStatus property for each admininstrator-deployed InfoPath form template. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell "SomeFormTemplate.xsn" | Get-SPInfoPathFormTemplate | format-list ``` @@ -44,6 +44,9 @@ This example lists all the properties of the specified InfoPath form template. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormsService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormsService.md index 7f77db1d3..86492fce9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormsService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathFormsService.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------------- +### EXAMPLE ```powershell Get-SPInfoPathFormsService ``` @@ -36,6 +36,9 @@ This example displays the InfoPath Forms Services settings for the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,8 +50,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath Forms Services settings to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathUserAgent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathUserAgent.md index b0da573aa..73d01e7e6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathUserAgent.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPInfoPathUserAgent ``` @@ -37,6 +37,9 @@ This example displays a list of user agents in the entire farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the user agent to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUserAgentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathWebServiceProxy.md index e4f7a05fb..f0663dac8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathWebServiceProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInfoPathWebServiceProxy.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPInfoPathWebServiceProxy -Identity "https://server_name" ``` @@ -36,6 +36,9 @@ This example displays the Web service proxy settings for a specified Web applica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web application to get. The type must be a valid URL, in the form https://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -43,8 +46,7 @@ The type must be a valid URL, in the form https://server_name, or a valid GUID, ```yaml Type: SPWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateSyncLastRunTime.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateSyncLastRunTime.md index 47fd3071f..847434e51 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateSyncLastRunTime.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateSyncLastRunTime.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the latest time the internal app state update job was invoked. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPInternalAppStateSyncLastRunTime ``` @@ -39,6 +38,9 @@ This example returns the latest time the internal app state update job was invok ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateUpdateInterval.md index 6b2752c91..bca49bdde 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPInternalAppStateUpdateInterval.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the interval in hours between updates of the internal app state update job. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Get-SPInternalAppStateUpdateInterval ``` @@ -39,6 +38,9 @@ This example returns the interval in hours between updates of the internal app s ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogEvent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogEvent.md index f5c34b9ae..5f4c1812f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogEvent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogEvent.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns results from a Unified Logging Service (ULS) trace log. - ## SYNTAX ### Directory @@ -44,42 +43,42 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPLogEvent -MinimumLevel "Warning" ``` This example returns all log entries equal to or more severe than Warning from the default log directory. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPLogEvent -Directory "C:\Logs" | Where-Object {$_.Level -eq "Warning"} ``` This example returns all warning entries from log files in the C:\Logs directory. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Get-SPLogEvent -StartTime "12/04/2007 17:00" -EndTime "12/04/2007 18:00" ``` This example returns error entries that occurred during a particular time range, which is culture-specific to the United States. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Get-SPLogEvent -ContextKey @("UserName" ,"SiteName") ``` This example returns the contents of the most recent log file and adds the specified context key data. -### --------------EXAMPLE 5----------------- +### EXAMPLE 5 ```powershell Get-SPLogEvent | Where-Object {$_.Level -eq "Error" -and {$_.Area -eq "SharePoint Foundation "} ``` This example returns all error entries related to SharePoint Foundation. -### --------------EXAMPLE 6----------------- +### EXAMPLE 6 ```powershell Get-SPLogEvent -ContextKey @("Name") | %{$_.ToString() + "'t" + $_.Context["Name"]} ``` @@ -89,6 +88,9 @@ This example returns the contents of the log file and adds context data. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,13 +112,15 @@ Accept wildcard characters: False ``` ### -AsString + +> Applicable: SharePoint Server Subscription Edition + Returns each record as a separate string ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,13 +130,15 @@ Accept wildcard characters: False ``` ### -ContextKey + +> Applicable: SharePoint Server Subscription Edition + Specifies that context data should be added to the results for the specified Context Keys, for example: `-ContextKey @("UserName", "SiteName")`. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,13 +148,15 @@ Accept wildcard characters: False ``` ### -Directory + +> Applicable: SharePoint Server Subscription Edition + Lists log files from an alternate directory (any directory other than the configured LogLocation directory). ```yaml Type: String Parameter Sets: Directory -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,14 +166,16 @@ Accept wildcard characters: False ``` ### -MinimumLevel + +> Applicable: SharePoint Server Subscription Edition + Returns records at or above the specified level. The valid values are Error or Warning. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,13 +185,15 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -192,13 +203,15 @@ Accept wildcard characters: False ``` ### -File + +> Applicable: SharePoint Server Subscription Edition + Specifies a specific file to query records from. ```yaml Type: String Parameter Sets: File -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -208,13 +221,15 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogLevel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogLevel.md index c5f2bbd7a..48acef249 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogLevel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPLogLevel.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a list of objects or diagnostic levels. - ## SYNTAX ``` @@ -29,28 +28,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPLogLevel ``` This example displays throttle levels for all categories. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPLogLevel -Identity "Category1" ``` This example displays the throttle level for the Category1 category. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell "Cat1", "Cat2", "Cat3" | Get-SpLogLevel ``` This example displays the throttle level for multiple categories. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Get-SPLogLevel -Identity "Area:*" ``` @@ -60,6 +59,9 @@ This example displays the throttle level for all categories in one area. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a valid category name; for example, Backup and Restore, or Administration. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedAccount.md index 53ff370d4..f5807e99e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedAccount.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves accounts registered in the configuration database. - ## SYNTAX ### Server @@ -47,7 +46,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPManagedAccount ``` @@ -57,6 +56,9 @@ This example displays all the managed accounts in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -64,8 +66,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope to a server. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -Service + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope to a service. ```yaml Type: SPServicePipeBind Parameter Sets: Service -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,13 +136,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope to a Web application. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedPath.md index cb661e977..c0a26c275 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPManagedPath.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all managed paths that match the given criteria. - ## SYNTAX ### HostHeader @@ -34,7 +33,7 @@ This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). -The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. +The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. If an Identity parameter is not provided, all managed paths for the given scope are returned. Host-named sites (no matter the Web application in which they are contained) share a single set of managed paths. @@ -44,14 +43,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPManagedPath -WebApplication https://sitename ``` This example returns all managed paths for the specified Web application. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPManagedPath -identity "Sites" -HostHeader ``` @@ -61,6 +60,9 @@ This example gets the Sites managed path from the host-named site collections-sc ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the managed path to return. The type must be a valid URL, in the https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -68,8 +70,7 @@ The type must be a valid URL, in the https://server_name or a valid GUID (for ex ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -79,13 +80,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + If provided, the managed paths returned are for the host-named sites in the farm. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the Web application from which to get the managed path. The type must be a valid URL, in the form https://server_name, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -102,8 +108,7 @@ The type must be a valid URL, in the form https://server_name, or a valid GUID ( ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -124,8 +132,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplication.md index cc5019d11..84c03194b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplication.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPMetadataServiceApplication -Identity "ManagedMetadataServiceApp1" ``` @@ -36,6 +36,9 @@ This example retrieves an existing managed metadata service application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed metadata service application to get. The type must be a valid GUID or the name of a valid managed metadata service application. @@ -43,8 +46,7 @@ The type must be a valid GUID or the name of a valid managed metadata service ap ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplicationProxy.md index 7b2f48084..304677596 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMetadataServiceApplicationProxy.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" ``` @@ -36,6 +36,9 @@ This example retrieves an existing connection to a managed metadata service appl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application proxy to read. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -43,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMicrofeedOptions.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMicrofeedOptions.md index 1adfffa77..bf2b3c4c3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMicrofeedOptions.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMicrofeedOptions.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spmicrofeedoptions -Applicable: SharePoint Server Subscription Edition + title: Get-SPMicrofeedOptions schema: 2.0.0 --- @@ -25,7 +25,7 @@ Returns the feed cache settings for the current user profile application. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy @@ -36,6 +36,9 @@ This example returns cache feed settings from the specified User Profile Service ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,13 +74,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMobileMessagingAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMobileMessagingAccount.md index 17c027793..f2ef47e18 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMobileMessagingAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPMobileMessagingAccount.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves mobile messaging accounts for the specified Web application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPMobileMessagingAccount -WebApplication https://sitename ``` @@ -40,6 +39,9 @@ This example retrieves the current mobile account settings information of the We ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are:SMS and MMS. If you do not specify this parameter, account information is returned for both SMS and MMS. @@ -48,7 +50,6 @@ If you do not specify this parameter, account information is returned for both S Type: SPMobileMessagingAccountPipeBind Parameter Sets: (All) Aliases: ServiceType, AccountType -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). @@ -66,8 +70,7 @@ You either must specify WebApplication or must use the HostHeader switch and spe ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPO365LinkSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPO365LinkSettings.md index e564c006c..829329819 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPO365LinkSettings.md @@ -23,7 +23,7 @@ Use the **Get-SPO365LinkSettings** cmdlet to display current hybrid configuratio ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell $gc = Start-SPAssignment Get-SPO365LinkSettings -AssignmentCollection $gc @@ -35,6 +35,9 @@ This example returns all hybrid configurations. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,8 +49,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSetting.md index 6e193c168..59a67e706 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSetting.md @@ -2,7 +2,7 @@ external help file: sharepointonline.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spodataconnectionsetting -Applicable: SharePoint Server Subscription Edition + title: Get-SPODataConnectionSetting schema: 2.0.0 --- @@ -13,7 +13,6 @@ schema: 2.0.0 Returns Business Connectivity Services OData connection properties. - ## SYNTAX ``` @@ -31,36 +30,35 @@ You cannot use this command in the SharePoint Online Management Shell. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp" ``` This example returns properties of the BCS connection named ContosoServiceApp -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPODataConnectionSetting -ServiceContext "http://contoso" ``` This example returns a list of BCS connections for the service context named http://contoso - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,12 +79,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,14 +92,15 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the Business Connectivity Services connection object. +> Applicable: SharePoint Server Subscription Edition + +Specifies the name of the Business Connectivity Services connection object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSettingMetadata.md index a8fdb45f9..bed967fbe 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSettingMetadata.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPODataConnectionSettingMetadata.md @@ -2,7 +2,7 @@ external help file: sharepointonline.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spodataconnectionsettingmetadata -Applicable: SharePoint Server Subscription Edition + title: Get-SPODataConnectionSettingMetadata schema: 2.0.0 --- @@ -13,7 +13,6 @@ schema: 2.0.0 Returns a Business Data Connectivity service metadata object. - ## SYNTAX ``` @@ -29,29 +28,28 @@ You cannot use this command in the SharePoint Online Management Shell. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPODataConnectionSettingMetadata -ServiceContext "http://contoso" -Name "ContosoServiceApp" ``` This example displays metadata properties of BCS connection named ContosoServiceApp - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,14 +59,15 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed. +> Applicable: SharePoint Server Subscription Edition + +Specifies the name of the Business Connectivity Services connection whose metadata properties the user wants to see displayed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,12 +88,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPOfficeStoreAppsDefaultActivation.md index 1753e7e4b..482d44ef0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPOfficeStoreAppsDefaultActivation.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPOfficeStoreAppsDefaultActivation.md @@ -2,7 +2,7 @@ external help file: sharepointserver.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spofficestoreappsdefaultactivation -Applicable: SharePoint Server Subscription Edition + title: Get-SPOfficeStoreAppsDefaultActivation schema: 2.0.0 --- @@ -13,7 +13,6 @@ schema: 2.0.0 Returns the properties of apps for Office. - ## SYNTAX ### AppsForOfficeSettingsInSiteSubscription @@ -37,17 +36,16 @@ Use the `Get-SPOfficeStoreAppsDefaultActivation` cmdlet to return settings for a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOfficeStoreAppsDefaultActivation -WebApplication https://sphvm-8044 ``` This examples returns the setting for the web application https://sphvm-8044. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 ``` @@ -57,14 +55,15 @@ This examples returns the Subscription ID setting for the tenant ## PARAMETERS ### -SiteSubscription -Specifies the Site Group to which the settings apply. +> Applicable: SharePoint Server Subscription Edition + +Specifies the Site Group to which the settings apply. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,14 +73,15 @@ Accept wildcard characters: False ``` ### -WebApplication -Specifies the URL, GUID, or name of the web application to which the setting applies. +> Applicable: SharePoint Server Subscription Edition + +Specifies the URL, GUID, or name of the web application to which the setting applies. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,12 +102,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPendingUpgradeActions.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPendingUpgradeActions.md index 0a03dbd9d..b1ce00ba6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPendingUpgradeActions.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPendingUpgradeActions.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays pending upgrade actions. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ```powershell Get-SPFarm | Get-SPPendingUpgradeActions -Recursive ``` @@ -37,6 +36,9 @@ Get-SPFarm | Get-SPPendingUpgradeActions -Recursive ## PARAMETERS ### -RootObject + +> Applicable: SharePoint Server Subscription Edition + Specifies a SharePoint object where you check for which upgrade actions are outstanding for that object based on its current upgrade status. This object must be inherited from IUpgradable. @@ -44,8 +46,7 @@ This object must be inherited from IUpgradable. ```yaml Type: IUpgradable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -62,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,13 +76,15 @@ Accept wildcard characters: False ``` ### -Recursive + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to perform the same pending upgrade action checks on each IUpgradable object that occurs under the RootObject parameter that is specified. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,13 +94,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgradeActionInfo + +> Applicable: SharePoint Server Subscription Edition + Specifies to not include pending upgrade actions for all child objects of a content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerConfig.md index 45556ad8c..3f409c2fd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerConfig.md @@ -24,7 +24,7 @@ This Get-SPPeoplePickerConfig cmdlet gets People Picker settings of a specified ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Get-SPPeoplePickerConfig -WebApplication http://MyOfficeApp1 ``` @@ -34,6 +34,9 @@ This example gets the People Picker settings of the Web application, MyOfficeApp ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to get People Picker settings from. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -95,7 +104,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerDistributionListSearchDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerDistributionListSearchDomain.md index fe47a8e5d..45bad69ea 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerDistributionListSearchDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerDistributionListSearchDomain.md @@ -25,14 +25,14 @@ The Get-SPGetPeoplePickerDistributionListSearchDomain cmdlet returns all domains ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Get-SPPeoplePickerDistributionListSearchDomain -WebApplication http://sitename ``` This example returns all domains in the People Picker distribution list search domains for users in the http://sitename web application. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Get-SPPeoplePickerDistributionListSearchDomain -WebApplication http://sitename -DomainName "corp.contoso.com" ``` @@ -42,6 +42,9 @@ This example returns the People Picker distribution list search entry in the htt ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,7 +57,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + Name of the domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application containing the People Picker search settings. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -96,13 +102,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,7 +130,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerSearchADDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerSearchADDomain.md index cb8f471e2..c20b1339b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerSearchADDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPeoplePickerSearchADDomain.md @@ -31,14 +31,14 @@ The Get-SPPeoplePickerSearchADDomain cmdlet returns all People Picker search for ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Get-SPPeoplePickerSearchADDomain -WebApplication http://sitename ``` This example returns all Active Directory forests or domains that the People Picker uses when searching for users in the http://sitename web application. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Get-SPPeoplePickerSearchADDomain -WebApplication http://sitename -DomainName "corp.contoso.com" -IsForest ``` @@ -48,6 +48,9 @@ This example returns the People Picker search entry in the http://sitename web a ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -60,7 +63,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + Name of the Active Directory forest or domain. ```yaml Type: String Parameter Sets: SpecificDomainParameterSet Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -IsForest + +> Applicable: SharePoint Server Subscription Edition + Specifies that the name specified by the DomainName parameter is an Active Directory forest. If the IsForest parameter is omitted, the name specified by the DomainName parameter is treated as an Active Directory domain. @@ -93,7 +100,6 @@ If the IsForest parameter is omitted, the name specified by the DomainName param Type: SwitchParameter Parameter Sets: SpecificDomainParameterSet Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -103,13 +109,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application containing the People Picker search settings. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -119,13 +127,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -135,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -142,7 +155,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPluggableSecurityTrimmer.md index 706d4df39..508bdd855 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPPluggableSecurityTrimmer.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $pr = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id @@ -37,6 +37,9 @@ This example gets a list of the pluggable security trimmers that are associated ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the User Profile service application proxy to which the pluggable security trimmers have been added. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProcessAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProcessAccount.md index a6de851e9..05f796a38 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProcessAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProcessAccount.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a system account or a managed account. - ## SYNTAX ### LocalService @@ -44,14 +43,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Get-SPProcessAccount -NetworkService ``` This example creates the SPProcessAccountPipeBind type by using the NetworkService account. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPProcessAccount -NetworkService | New-SPServiceApplicationPool -Account $_ ``` @@ -61,6 +60,9 @@ This example creates an SPServiceApplicationPool account by using the NetworkSer ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -LocalService + +> Applicable: SharePoint Server Subscription Edition + Returns the LocalService account. ```yaml Type: SwitchParameter Parameter Sets: LocalService -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -LocalSystem + +> Applicable: SharePoint Server Subscription Edition + Returns the LocalSystem account. ```yaml Type: SwitchParameter Parameter Sets: LocalSystem -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -NetworkService + +> Applicable: SharePoint Server Subscription Edition + Returns the NetworkService account. ```yaml Type: SwitchParameter Parameter Sets: NetworkService -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProduct.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProduct.md index 151e7ba53..4736c2a93 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProduct.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProduct.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. - ## SYNTAX ### Local @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPProduct -Local ``` @@ -51,6 +50,9 @@ This example displays the SharePoint-related products installed on the local ser ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -62,8 +64,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,14 +74,16 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Returns product and update information for only the local computer. If you use the Local parameter, you cannot use the Server parameter. ```yaml Type: SwitchParameter Parameter Sets: Local -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,14 +93,16 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server Subscription Edition + Returns product and update information for a specified server. If you use the Server parameter, you cannot use the Local parameter. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileLeader.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileLeader.md index 508a38a6a..552551a8c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileLeader.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileLeader.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE----------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Get-SPProfileLeader -ProfileServiceApplicationProxy $proxy @@ -42,13 +42,15 @@ This example returns a company leader from the specific user profile service app ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,14 +84,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileServiceApplicationSecurity.md index 07434166b..b0b1fd848 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProfileServiceApplicationSecurity.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} PS Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy -Type MySiteReaderACL @@ -43,13 +43,15 @@ This example displays MySite information on UPA Proxy 1. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +71,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,14 +81,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of object to display. The type is any one of the following values: @@ -105,8 +114,7 @@ The type is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseQuota.md index 2bbf645c7..3cbc01f8a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseQuota.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseQuota.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectdatabasequota -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectDatabaseQuota schema: 2.0.0 --- @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell ``` @@ -33,13 +33,15 @@ For permissions and the most current information about Windows PowerShell for Pr ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -49,13 +51,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseUsage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseUsage.md index 787e2640f..40582f4fc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseUsage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectDatabaseUsage.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectdatabaseusage -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectDatabaseUsage schema: 2.0.0 --- @@ -23,7 +23,7 @@ Returns an approximate size, in megabytes (MB) of the Project Web App data used ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPProjectDatabaseUsage -Url https://contoso.com/sites/pwa ``` @@ -33,6 +33,9 @@ This example shows the size of the Project Web App data in the content data for ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -51,13 +53,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App site collection. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEnterpriseProjectTaskSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEnterpriseProjectTaskSync.md index a66655147..d5d56f490 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEnterpriseProjectTaskSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEnterpriseProjectTaskSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectenterpriseprojecttasksync -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectEnterpriseProjectTaskSync schema: 2.0.0 --- @@ -24,7 +24,7 @@ Returns whether the task list sync between Project Web App and project sites is ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPProjectEnterpriseProjectTaskSync -Url https://contoso/sites/PWA ``` @@ -34,6 +34,9 @@ This example shows the syntax for getting the task sync status for the Project W ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the PWA site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEventServiceSettings.md index e6a094fdc..2fbddc1b4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectEventServiceSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojecteventservicesettings -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectEventServiceSettings schema: 2.0.0 --- @@ -23,7 +23,7 @@ Returns the settings for the Microsoft Project Server Events Service. There is c ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPProjectEventServiceSettings ``` @@ -33,6 +33,9 @@ This example shows what port the service is listening on. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectIsEmailNotificationEnabled.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectIsEmailNotificationEnabled.md index 4d031eeac..4a15ddfe4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectIsEmailNotificationEnabled.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectIsEmailNotificationEnabled.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectisemailnotificationenabled -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectIsEmailNotificationEnabled schema: 2.0.0 --- @@ -24,7 +24,7 @@ Returns the Project Web App site level setting for email notifications. True if ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPProjectIsEmailNotificationEnabled -Url https://contoso/sites/pwa ``` @@ -34,6 +34,9 @@ Returns the status of email notifications for the PWA site https://contoso/sites ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectOdataConfiguration.md index 77d479d2e..e9c9bfe95 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectOdataConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectOdataConfiguration.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectodataconfiguration -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectOdataConfiguration schema: 2.0.0 --- @@ -19,7 +19,7 @@ Get-SPProjectOdataConfiguration [-AssignmentCollection ] ``` ## DESCRIPTION -The Get-SPProjectOdataConfiguration cmdlet returns the settings for how the OData service is configured for an instance of Project Web App. +The Get-SPProjectOdataConfiguration cmdlet returns the settings for how the OData service is configured for an instance of Project Web App. It returns the current settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled, and whether verbose errors are enabled. The cmdlet can also be used to return an itemized list of entities that have an override specified for their maximum page size. @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Get-SPProjectOdataConfiguration ``` This example returns the OData configuration for the instance of Project Web App. -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell (Get-SPProjectOdataConfiguration).EntitySetsWithMaxPAgeSizeOverride ``` @@ -44,6 +44,9 @@ This example returns the list of entities that have the MaxPageSizeOverride opti ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,8 +58,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPCSSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPCSSettings.md index 49e6558c1..4c0f00a71 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPCSSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectpcssettings -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectPCSSettings schema: 2.0.0 --- @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPProjectPCSSettings -sa "Project Service Application" ``` @@ -37,13 +37,15 @@ This example reads the settings for the Project Calculation Engine running on th ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + The Project Server Service Application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -64,8 +69,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPermissionMode.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPermissionMode.md index 0fe9818ff..3b51177db 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPermissionMode.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectPermissionMode.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectpermissionmode -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectPermissionMode schema: 2.0.0 --- @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ```powershell Get-SPProjectPermissionMode -Url https://AppServer/pwa ``` @@ -35,6 +35,9 @@ This example returns the permission mode setting for a PWA instance. ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the PWA instance for which you want to retrieve the permission mode. The type must be a valid URL, in the form https://\/\. @@ -42,8 +45,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -64,8 +69,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectQueueSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectQueueSettings.md index 1de66ecee..261460f1d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectQueueSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectqueuesettings -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectQueueSettings schema: 2.0.0 --- @@ -39,7 +39,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Get-SPProjectQueueSettings -ServiceApplication "Project Service Application" ``` @@ -49,6 +49,9 @@ This example retrieves the queue settings for the "Project Service Application" ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg; a valid name of a Project Server Service Application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -57,7 +60,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg; Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +83,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectWebInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectWebInstance.md index 86a293035..c0e5affa6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPProjectWebInstance.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spprojectwebinstance -Applicable: SharePoint Server Subscription Edition + title: Get-SPProjectWebInstance schema: 2.0.0 --- @@ -38,7 +38,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPProjectWebInstance -Url https://server/pwa ``` @@ -48,6 +48,9 @@ This example returns the properties for a Project Web App instance at https://se ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Project Server service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Web App instance (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -56,7 +59,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance to get. The type must be a valid URL, in the form https://\/\. @@ -95,8 +102,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRemoteShareBlobStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRemoteShareBlobStore.md index 633536007..66a10540e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRemoteShareBlobStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRemoteShareBlobStore.md @@ -35,21 +35,21 @@ This cmdlet can help you to get a specific BLOB store, or all the BLOB stores fo ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Get-SPRemoteShareBlobStore ``` Gets all the Remote Share BLOB Stores in the SharePoint farm. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Get-SPRemoteShareBlobStore -RemoteShareBlobStore "RemoteBlobStore" ``` Gets the Remote Share BLOB Store named "RemoteBlobStore." -### -------------EXAMPLE 3------------- +### EXAMPLE 3 ```powershell Get-SPRemoteShareBlobStore -ContentDatabase "WSS_Content" ``` @@ -59,6 +59,9 @@ Gets all the Remote Share BLOB Stores registered in content database "WSS_Conten ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,7 +73,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,13 +82,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies a content database to get the Remote Share BLOB Store. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDatabase Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -96,13 +100,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a Remote Share BLOB store name to get the Remote Share BLOB Store. ```yaml Type: String Parameter Sets: ContentDatabase Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +118,9 @@ Accept wildcard characters: False ``` ### -RemoteShareBlobStore + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Remote Share BLOB Store. It can either be the Remote Share BLOB Store object or the Remote Share BLOB Store name. @@ -120,7 +129,6 @@ It can either be the Remote Share BLOB Store object or the Remote Share BLOB Sto Type: SPRemoteShareBlobStorePipeBind Parameter Sets: DefaultSet Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,13 +138,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,6 +156,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -153,7 +166,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRequestManagementSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRequestManagementSettings.md index 04bc5813f..dcc8cdb17 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRequestManagementSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRequestManagementSettings.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a Request Manager object. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE------- +### EXAMPLE ```powershell Get-SPRequestManagementSettings -Identity ``` @@ -39,13 +38,15 @@ This example returns a request manager object for a specified identity. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the web-application for which a user wants to enable routing or throttling. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachineInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachineInfo.md index 78747bbd8..8a7ba9dde 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachineInfo.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all the routing targets. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------------ +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -42,13 +41,15 @@ This example returns a routing target for a specified identity. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not the specified computer will be available for routing. If no value is specified, all computers are returned. @@ -93,8 +99,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the computer for which you want to return routing information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachinePool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachinePool.md index af87ad336..08bdabffd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingMachinePool.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all available routing pools. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE--------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -41,13 +40,15 @@ This example returns a routing pool for the specified identity. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the machine pool to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingRule.md index 118f018d9..e33d1a6a5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPRoutingRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all routing rules. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------ +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -41,13 +40,15 @@ This example returns a routing rule for the farm. ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the rule to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabase.md index ba529a4f2..a91c40de8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all scale-out database objects. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------------- +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Get-SPScaleOutDatabase -ServiceApplication $serviceApplication @@ -43,13 +42,15 @@ This example gets all scale-out databases for the given service application by u ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseDataState.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseDataState.md index 4c1f05c67..5bf014324 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseDataState.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseDataState.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the state information about the specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE-------------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -54,13 +53,15 @@ This example gets the data state of the scale-out database for the first scale-o ## PARAMETERS ### -ConnectionString + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection string for the scale-out database from which to return the state information. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,13 +71,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to return the state information about. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +103,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the state information of the scale-out database is in the form of a Microsoft SQL Azure Database. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseInconsistency.md index 52494be09..04cb0aae5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseInconsistency.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseInconsistency.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays all inconsistencies related to scale-out databases' ranges. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Get-SPScaleOutDatabaseInconsistency -ServiceApplication $serviceApplication @@ -40,13 +39,15 @@ This example gets all the scale-out inconsistencies for the given service applic ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application for which to return the scale-out inconsistencies. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseLogEntry.md index 21c91c5cf..41307100c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseLogEntry.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPScaleOutDatabaseLogEntry.md @@ -14,7 +14,6 @@ schema: 2.0.0 Queries a scale-out database for scale-out logs. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE----------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -43,13 +42,15 @@ This example gets the 10 most recent scale-out log entries from the first scale- ## PARAMETERS ### -Count + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of scale-out log entries to return. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database from which to return the scale-out logs ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,14 +121,16 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: SharePoint Server Subscription Edition + Specifies the correlation id of the scale-out logs to be returned. Correlation id of the log entries that belong to the same major action are the same. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -MajorAction + +> Applicable: SharePoint Server Subscription Edition + Specifies the major action of the scale-out log entries to be returned. The values are the following: @@ -141,8 +153,7 @@ Recovery -Any data recovery operation that is performed to recover from a failur ```yaml Type: SPScaleOutDatabaseMajorAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +164,8 @@ Accept wildcard characters: False ### -RangeLimitPoint +> Applicable: SharePoint Server Subscription Edition + Specifies the range limit point of the scale-out log entries to be returned. The range limit point has different meaning depending on the action that records the log entry. @@ -165,12 +178,10 @@ The range limit point has different meaning depending on the action that records --If the action extends the end point of the data range, range limit point represents the new end point of the data range. - ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreApplication.md index 66339d3f9..c816034a8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreApplication.md @@ -37,14 +37,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" ``` This example gets the Secure Store application for the target application with the name ContosoTargetApplication. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPSecureStoreApplication -ServiceContext http://contoso -All ``` @@ -54,13 +54,15 @@ This example returns all of the Secure Store applications http://contoso. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Secure Store application to get. ```yaml Type: String Parameter Sets: NameSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for the local Secure Store application to connect to. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -93,8 +100,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +110,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server Subscription Edition + Returns all secure store applications for the given Service Context. ```yaml Type: SwitchParameter Parameter Sets: AllSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreSystemAccount.md index c25431350..e6e49c98e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecureStoreSystemAccount.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ```powershell Get-SPSecureStoreSystemAccount ``` @@ -35,6 +35,9 @@ This example returns a list of user accounts for the secure store system. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,8 +49,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecurityTokenServiceConfig.md index 4c7dba1e1..ea0326832 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecurityTokenServiceConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSecurityTokenServiceConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the security token service (STS) for the farm. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPSecurityTokenServiceConfig -ServiceTokenLifetime 1000 ``` @@ -39,6 +38,9 @@ This example gets the security token service (STS) for the farm and sets the exp ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServer.md index ef9e1301f..3be5b1c77 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Returns the server or servers in the farm that match the given identity. - ## SYNTAX ``` @@ -28,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPServer ``` This example returns all servers in the local farm in a list. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPServer | Where{ $_.NeedsUpgrade -eq $TRUE} ``` @@ -45,13 +44,15 @@ This example returns a list of all servers in the farm that need an upgrade. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the address of the server to return. ```yaml Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabase.md index 2114bab48..3a36ac54f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all scale-out database objects. - ## SYNTAX ``` @@ -31,10 +30,9 @@ For more information, see SharePoint Shared Service Database Scale Out Generic P - ## EXAMPLES -### ----------EXAMPLE-------------- +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication @@ -42,21 +40,20 @@ Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication This example gets all scale-out databases for the given service application by using the $serviceApplication variable. - ## PARAMETERS ### -ServiceApplication -Specifies the service application of the scale-out databases. +> Applicable: SharePoint Server Subscription Edition +Specifies the service application of the scale-out databases. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +64,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,13 +76,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,17 +90,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,18 +111,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseDataState.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseDataState.md index c8e6e7feb..00b351068 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseDataState.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseDataState.md @@ -15,7 +15,6 @@ Returns the state information about the specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -41,10 +40,9 @@ The database state information includes total count of partitions, total weight - ## EXAMPLES -### ----------------EXAMPLE-------------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -53,22 +51,20 @@ Get-SPServerScaleOutDatabaseDataState -Database $database This example gets the data state of the scale-out database for the first scale-out database of the given service application. - ## PARAMETERS ### -ConnectionString -Specifies the connection string for the scale-out database from which to return the state information. - +> Applicable: SharePoint Server Subscription Edition +Specifies the connection string for the scale-out database from which to return the state information. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,15 +75,15 @@ Accept wildcard characters: False ### -Database -Specifies the scale-out database for which the command returns state information. +> Applicable: SharePoint Server Subscription Edition +Specifies the scale-out database for which the command returns state information. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -98,6 +94,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,12 +106,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,15 +120,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -143,17 +139,16 @@ Accept wildcard characters: False ### -IsAzureDatabase -Specifies whether the state information of the scale-out database is in the form of a Microsoft Windows Azure SQL Database. - +> Applicable: SharePoint Server Subscription Edition +Specifies whether the state information of the scale-out database is in the form of a Microsoft Windows Azure SQL Database. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,16 +159,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseInconsistency.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseInconsistency.md index 04f739d13..fe10e890a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseInconsistency.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseInconsistency.md @@ -15,7 +15,6 @@ Displays all inconsistencies related to scale-out databases' ranges. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Use the Get-SPServerScaleOutDatabaseInconsistency cmdlet to return all inconsist - ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ```powershell $serviceApplication = Get-SPServiceApplication -Name "AppManagement" Get-SPServerScaleOutDatabaseInconsistency -ServiceApplication $serviceApplication @@ -44,16 +42,16 @@ This example gets all the scale-out inconsistencies for the given service applic ### -ServiceApplication -Specifies the service application for which to return the scale-out inconsistencies. +> Applicable: SharePoint Server Subscription Edition +Specifies the service application for which to return the scale-out inconsistencies. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -64,6 +62,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,12 +74,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,16 +88,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -110,17 +108,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseLogEntry.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseLogEntry.md index 1218c9243..a0809b0ca 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseLogEntry.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServerScaleOutDatabaseLogEntry.md @@ -14,7 +14,6 @@ schema: 2.0.0 Queries a scale-out database for scale-out logs. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Get-SPServerScaleOutDatabaseLogEntry -Count -Database Applicable: SharePoint Server Subscription Edition +Specifies the number of scale-out log entries to return. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,15 +62,15 @@ Accept wildcard characters: False ### -Database -Specifies the scale-out database from which to return the scale-out logs +> Applicable: SharePoint Server Subscription Edition +Specifies the scale-out database from which to return the scale-out logs ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,6 +81,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,12 +93,10 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,18 +107,17 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,16 +128,16 @@ Accept wildcard characters: False ### -CorrelationId +> Applicable: SharePoint Server Subscription Edition + Specifies the correlation id of the scale-out logs to be returned. Correlation id of the log entries that belong to the same major action are the same. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +148,8 @@ Accept wildcard characters: False ### -MajorAction +> Applicable: SharePoint Server Subscription Edition + Specifies the major action of the scale-out log entries to be returned. The values are the following: @@ -162,12 +159,10 @@ Recovery -Any data recovery operation that is performed to recover from a failur - ```yaml Type: SPScaleOutDatabaseMajorAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,18 +173,18 @@ Accept wildcard characters: False ### -RangeLimitPoint +> Applicable: SharePoint Server Subscription Edition + Specifies the range limit point of the scale-out log entries to be returned. The range limit point has different meaning depending on the action that records the log entry. - ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,17 +195,17 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPService.md index dad5d18ce..98737186e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPService.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spservice -Applicable: SharePoint Server Subscription Edition + title: Get-SPService schema: 2.0.0 --- @@ -24,7 +24,7 @@ The Get-SPService cmdlet gets a service in the farm. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPService -Identity 'Microsoft SharePoint Server Diagnostics Service' ``` @@ -34,13 +34,15 @@ This example gets the Microsoft SharePoint Server Diagnostics Service in the far ## PARAMETERS ### -All + +> Applicable: SharePoint Server Subscription Edition + Specifies all services in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -50,14 +52,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -67,13 +71,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service to get. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplication.md index b513cfaac..80244ba14 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the specified service application. - ## SYNTAX ``` @@ -30,21 +29,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Get-SPServiceApplication ``` This example returns all service applications in the farm. -### ------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPServiceApplication -Identity e2c2be70-6382-4ce7-8a44-ae7dadff5597 ``` This example returns the service application that has the Identity "e2c2be70-6382-4ce7-8a44-ae7dadff5597". -### ------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ```powershell Get-SPServiceApplication -Name AccountingServiceApp ``` @@ -56,13 +55,15 @@ You can use either the Identity or the Name parameter but if you use both, the c ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application to get. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +87,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the friendly name of the new usage application.The type must be a valid name of a usage application; for example, UsageApplication1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationEndpoint.md index a12f80601..197ab6455 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationEndpoint.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationEndpoint.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the endpoint of a service application. - ## SYNTAX ### Identity @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Get-SPServiceApplicationEndpoint -ServiceApplication "ServiceSubApp1" ``` @@ -51,6 +50,9 @@ This example returns the SPServiceEndpoint object based on the specified service ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service endpoint to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form https://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. @@ -58,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +70,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -76,8 +80,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: Name -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +104,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application endpoint. The type must be a valid name of an service application endpoint; for example, SvcAppEndpoint1. @@ -116,8 +124,7 @@ The type must be a valid name of an service application endpoint; for example, S ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationPool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationPool.md index e36d78954..c50946132 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationPool.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the specified Internet Information Services (IIS) application pool. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPServiceApplicationPool ``` @@ -39,13 +38,15 @@ This example returns all the service application pools in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or identifier (ID) of the application pool to get. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxy.md index 18d22bb8a..e2c1b3e0a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxy.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns an instance of the specified service application proxy. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPServiceApplicationProxy ``` @@ -43,13 +42,15 @@ This example retrieves all the service application proxies in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application proxy to return. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxyGroup.md index d8601cafa..15dcd541a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationProxyGroup.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the proxy group for the specified service application. - ## SYNTAX ### Identity @@ -38,7 +37,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPServiceApplicationProxyGroup ``` @@ -48,13 +47,15 @@ This example retrieves all of the service application proxy groups in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or the GUID of the proxy group. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -64,13 +65,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + Returns the default service proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: Default identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationSecurity.md index 0cccd197b..b14516eab 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceApplicationSecurity.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the SPObjectSecurity object for a service application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $security = Get-SPServiceApplicationSecurity $serviceApp -Admin Grant-SPObjectSecurity $security $principal "Full Control" @@ -43,6 +42,9 @@ The new user is an administrator for the service application $serviceApp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, SearchServiceApp1); or an instance of a valid SPServiceApplication object. @@ -50,8 +52,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,13 +62,15 @@ Accept wildcard characters: False ``` ### -Admin + +> Applicable: SharePoint Server Subscription Edition + Returns the access control list (ACL) that contains the administrators list of the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceContext.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceContext.md index 734fe6d7e..457adc189 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceContext.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceContext.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a service context. - ## SYNTAX ### Site @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ```powershell $sitesub = Get-SPSiteSubscription https://my.contoso.com/ Get-SPServiceContext $sitesub @@ -52,6 +51,9 @@ This example returns the service context for a site in a hosted environment. ## PARAMETERS ### -Site + +> Applicable: SharePoint Server Subscription Edition + Returns the service context for only the Web application that contains the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -59,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Returns all of the service contexts for all Web applications in which the specified site subscription has site collections. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -77,8 +81,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +105,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceHostConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceHostConfig.md index a24010af2..babd03825 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceHostConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceHostConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the common Web service settings. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------------- +### EXAMPLE ```powershell Get-SPServiceHostConfig ``` @@ -38,6 +37,9 @@ This example displays the Web service settings. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -60,13 +61,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + This parameter has no effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceInstance.md index c066ddbab..6c0663820 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPServiceInstance.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the services instance for a specific server or the entire farm. - ## SYNTAX ### Identity @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPServiceInstance -Server ServerA ``` @@ -51,6 +50,9 @@ This example displays the service instances from a given server. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service instance. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -58,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceInstancePipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -69,13 +70,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server Subscription Edition + Specifies the server from which to return the service instance. ```yaml Type: SPServerPipeBind Parameter Sets: Server -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -92,8 +98,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server Subscription Edition + Returns all services instance in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSessionStateService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSessionStateService.md index 3baa3cd9f..01bdcec83 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSessionStateService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSessionStateService.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPSessionStateService ``` @@ -35,6 +35,9 @@ This example returns the current configuration of the session state service. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,8 +49,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPShellAdmin.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPShellAdmin.md index 4f27bcf71..8c06a24a6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPShellAdmin.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPShellAdmin.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the names of all users who have the SharePoint_Shell_Access role. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE---------------------- +### EXAMPLE ```powershell Get-SPShellAdmin -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` @@ -39,14 +38,16 @@ This example returns the name of each user who has the SharePoint_Shell_Access r ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the database or the Database Object that includes the SharePoint_Shell_Access role whose user names you want to display. If the database parameter is not specified, the configuration database is used. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSite.md index 3eea8b7f3..d6a2ad092 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all site collections that match the specified criteria. - ## SYNTAX ### AllSitesInIdentity @@ -72,21 +71,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Get-SPSite 'https://' | Get-SPWeb -Limit All | Select Title ``` This example gets the collection of subweb titles in site collection at https://\. -### ------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryContact ``` This example gets a subset of data from all sites in the content database b399a366-d899-4cff-8a9b-8c0594ee755f. -### ------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Start-SPAssignment -Global $s = Get-SPSite -Identity https:///Sites/Site1 @@ -100,7 +99,7 @@ The previous example uses the Global method of assignment collection. The Global method is easy to use but the contents of this object grows quickly. Be careful not to run a Get-SPSite command that returns many results while global assignment is enabled. -### ------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ```powershell $GC = Start-SPAssignment $Sites = $GC | Get-SPSite -Filter {$_.Owner -eq "DOMAIN\JDow"} -Limit 50 @@ -111,14 +110,14 @@ This example gets the first 50 sites owned by user DOMAIN\JDow by using a server This example uses advanced assignment collection methods. -### ------------------EXAMPLE 5--------------------- +### EXAMPLE 5 ```powershell Get-SPWebApplication https:// | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum} ``` This example shows a command that returns the sum of the disk space usage for all sites in a given web application. -### ------------------EXAMPLE 6--------------------- +### EXAMPLE 6 ```powershell Get-SPSite -Identity "https://localserver/(my|personal)/sites" -Regex ``` @@ -127,21 +126,21 @@ This example returns all sites that match the given regular expression. The Quotes on the Identity parameter are required when the Regex parameter is used. -### ------------------EXAMPLE 7--------------------- +### EXAMPLE 7 ```powershell Get-SPSite https:///sites/teams/* -Limit 100 ``` This example gets up to 100 of the sites under the URL https://sitename/sites/teams. -### ------------------EXAMPLE 8--------------------- +### EXAMPLE 8 ```powershell Get-SPSite | select url, @{Expression={$_.Usage.Storage}} ``` This example gets the amount of storage used by a site collection, by using the storage field of the .UsageInfo property. -### ------------------EXAMPLE 9--------------------- +### EXAMPLE 9 ```powershell Get-SPSite -Limit all -CompatibilityLevel 14 ``` @@ -151,6 +150,9 @@ This example returns all SharePoint Server mode site collections. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to get. The type must be a valid URL, in the form, https://server_name or https://server_name/sites/sitename, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -158,8 +160,7 @@ The type must be a valid URL, in the form, https://server_name or https://server ```yaml Type: SPSitePipeBind Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -169,6 +170,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name, in the form, SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -176,8 +180,7 @@ The type must be a valid database name, in the form, SPContentDB01, or a valid G ```yaml Type: SPContentDatabasePipeBind Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -187,6 +190,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription from which to get site collections. The type must be a valid URL, in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -194,8 +200,7 @@ The type must be a valid URL, in the form, https://server_name or a valid GUID ( ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -205,6 +210,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -212,8 +220,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -223,6 +230,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be either SharePoint Server or SharePoint Server. @@ -231,8 +241,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -242,6 +251,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -249,7 +261,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -259,6 +270,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server Subscription Edition + Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value in the form {$_PropertyName \ "filterValue"}. @@ -268,8 +282,7 @@ Valid operators are: EQ, NE, LIKE, NOTLIKE. ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -279,6 +292,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Limits the maximum number of site collections to return. The default value is 200. @@ -288,8 +304,7 @@ Specify ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -299,13 +314,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server Subscription Edition + When used, the URL provided for the Identity parameter is treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -315,6 +332,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the web application from which to list sites. The type must be a valid URL, in the form, https://server_name, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the name of the web application (for example, WebApplication1212). @@ -322,8 +342,7 @@ The type must be a valid URL, in the form, https://server_name, a valid GUID (fo ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -333,6 +352,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -340,7 +362,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -350,6 +371,9 @@ Accept wildcard characters: False ``` ### -NeedsB2BUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the site needs to be upgraded. The valid values are True and False. @@ -357,8 +381,7 @@ The valid values are True and False. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteAdministration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteAdministration.md index 6cb4db54b..e83679d55 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteAdministration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteAdministration.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access. - ## SYNTAX ### AllSitesInIdentity @@ -55,7 +54,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage";Expression={$_.Quota.StorageMaximumLevel}} ``` @@ -63,7 +62,7 @@ Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage This example gets a subset of data from all of the sites in the content database with the URL b399a366-d899-4cff-8a9b-8c0594ee755f (farm administrator does not require access). This command uses the calculated property Storage to display the maximum storage value for the content database. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Start-SPAssignment -Global $s = Get-SPSiteAdministration -Identity https://MyApp/Sites/Site1 @@ -76,7 +75,7 @@ This example uses the Global method of garbage collection. This method is easier to use but grows quickly. Do not run a Get-SPSite command that returns many results while global assignment is on. -### ------------------EXAMPLE 3------------------- +### EXAMPLE 3 ```powershell $GC = Start-SPAssignment $Sites = $GC | Get-SPSiteAdministration -Filter {$_.Owner -eq "DOMAIN\JDoe"} -Limit 50 @@ -86,21 +85,21 @@ Stop-SPAssignment $GC This example gets the first 50 sites owned by user DOMAIN\JDoe by using a server-side query, and assigns the returned sites to a local variable. This command uses advanced assignment collection methods. -### ------------------EXAMPLE 4------------------ +### EXAMPLE 4 ```powershell Get-SPWebApplication https://sitename | Get-SPSiteAdministration -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.DiskUsed }{$sum} ``` This command returns the sum of the disk space usage for all sites in the specified Web application. -### ------------------EXAMPLE 5------------------ +### EXAMPLE 5 ```powershell Get-SPWebApplication https://sitename | Get-SPSiteAdministration -Limit ALL | Select URL ``` This example gets the URLs for all site collections in a Web application. -### ------------------EXAMPLE 6------------------ +### EXAMPLE 6 ```powershell Get-SPSiteAdministration -identity "https://localserver/(my|personal)/sites" -Regex ``` @@ -108,7 +107,7 @@ Get-SPSiteAdministration -identity "https://localserver/(my|personal)/sites" -Re This example returns all sites that match the given regular expression. The quotation marks around the value specified for the Identity parameter are required when using the Regex flag. -### ------------------EXAMPLE 7------------------ +### EXAMPLE 7 ```powershell Get-SPSite "https://sitename/sites/teams/*" -Limit 100 ``` @@ -118,6 +117,9 @@ This example gets up to 100 of the sites under the URL https://sitename/sites/te ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL (full or partial) or GUID of the site collection to retrieve. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-456-987fg. @@ -125,8 +127,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPSiteAdministrationPipeBind Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -136,6 +137,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL (full or partial) or GUID of the site collection to retrieve. The type must be a valid URL, in the form https://server_name, or a GUID, in the form, 1234-456-987fg. @@ -143,8 +147,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPContentDatabasePipeBind Parameter Sets: AllSitesInContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -154,6 +157,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site group from which to get site collections. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -161,8 +167,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AllSitesInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -172,6 +177,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -183,8 +191,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,6 +201,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -201,7 +211,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -211,6 +220,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server Subscription Edition + Specifies the script block of the server-side filter to apply. The type must be a valid filter name and a value in the form { $_ PropertyName \ "filterValue"}} @@ -218,8 +230,7 @@ The type must be a valid filter name and a value in the form { $_ PropertyName \ ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -229,6 +240,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Limits the maximum number of site collections to return. The default value is 200. @@ -238,8 +252,7 @@ Provide ALL to return all site collections for the given scope. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -249,13 +262,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server Subscription Edition + Enabling this switch causes the URL provided for the Identity parameter to be treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: AllSitesInIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -265,6 +280,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL, in the form https://server_name; a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the Web application name (for example, WebApplication1212). @@ -272,8 +290,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID (for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AllSitesInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -283,6 +300,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -290,7 +310,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteMaster.md index 240d0216b..67dc0ee51 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spsitemaster -Applicable: SharePoint Server Subscription Edition + title: Get-SPSiteMaster schema: 2.0.0 --- @@ -38,7 +38,7 @@ Typically the following information is displayed: ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPSiteMaster -ContentDatabase WSS_Content ``` @@ -48,6 +48,9 @@ This example returns the site master in the database WSS_Content. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -55,8 +58,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -66,13 +68,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to get the list of Site Masters. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscription.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscription.md index ffc5e182c..1c22f87f4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscription.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscription.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the site subscription for the given URL or all site subscriptions in the local farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE---------------------- +### EXAMPLE ```powershell $SiteSub = Get-SPSiteSubscription https://Contoso.com $SiteSub = Get-SPSite https://contoso.com | Get-SPSiteSubscription @@ -41,6 +40,9 @@ This example retrieves the site subscription for https://Contoso.com. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the subscription. The type must be a valid URL, in the form https://server_name. @@ -48,8 +50,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionConfig.md index 8d57eb28e..3314d3fe5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the configuration properties of a site subscription. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ```powershell Get-SPSiteSubscriptionConfig https://contoso.com | Select FeatureSet ``` @@ -39,6 +38,9 @@ This example gets the feature set ID for the site subscription that contains the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription configuration to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoveryHub.md index da94b704b..95b77273e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoveryHub.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoveryHub.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE---------------------- +### EXAMPLE ```powershell Get-SPSiteSubscriptionEdiscoveryHub -Identity https://contoso.com ``` @@ -36,14 +36,16 @@ This example displays the eDiscovery hub for the specified site collection. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the site collections to the eDiscovery hub. Can pipe the result from the Get-SPSiteSubscription cmdlet. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -64,8 +69,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -82,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -92,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoverySearchScope.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoverySearchScope.md index b39973332..bd5d0c40c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoverySearchScope.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionEdiscoverySearchScope.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Get-SPSiteSubscriptionEdiscoverySearchScope -Identity https://contoso.com ``` @@ -36,13 +36,15 @@ This example displays the search scope for the eDiscovery hub for the specified ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to the group of site collections that contained the search scope. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -63,8 +68,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -81,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionFeaturePack.md index 4ddabc619..dbf036153 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionFeaturePack.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription. - ## SYNTAX ### FeaturePack @@ -42,14 +41,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get- SPSiteSubscriptionFeaturePack ``` This example returns all defined Feature sets in the local farm. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPSiteSubscriptionFeaturePack -SiteSubscription https://contoso.com | ForEach{ $_.FeatureDefinitions } ``` @@ -59,13 +58,15 @@ This example returns the list (name, ID, and scope) of all Features allowed in t ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a valid name or GUID of the Feature set. ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: FeaturePack -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + If provided, ensures that the returned Feature set is the Feature set that is currently assigned to the given site subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionIRMConfig.md index dddca5f1a..19b5c34a1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionIRMConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionIRMConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Gets the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell site = Get-SPSite https://myspserver $subscription = $site.SiteSubscription @@ -41,13 +40,15 @@ This example gets the IRM settings for a specified tenant by using the Identity ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription for a particular tenant. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionMetadataConfig.md index 5ad25f2bf..da5502bd1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteSubscriptionMetadataConfig.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` @@ -37,6 +37,9 @@ This example retrieves the site subscription-specific settings for an existing p ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription to read. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the metadata Service application for the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -62,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteURL.md index 0e18e5b7c..c68777a99 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteURL.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays all URL mappings for the site. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------- +### EXAMPLE ```powershell $site = Get-SPSite 'https://www.contoso.com' Get-SPSiteURL -Identity $site @@ -43,14 +42,16 @@ This example displays all the URLs that bind to the site collection, https://www ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to display. Must be the root site collection of a host name. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteUpgradeSessionInfo.md index d54f0c4c2..47eaeaadc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteUpgradeSessionInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSiteUpgradeSessionInfo.md @@ -14,7 +14,6 @@ schema: 2.0.0 Manage or report site upgrade. - ## SYNTAX ### ContentDB @@ -43,7 +42,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell $db = Get-SPContentDatabase -Identity wss_content Get-SPSiteUpgradeSessionInfo -ContentDatabase $db @@ -51,7 +50,7 @@ Get-SPSiteUpgradeSessionInfo -ContentDatabase $db This example returns siteupgradeinfo for every SPContentDatabase returned from Get-SPContentDatabase cmdlet. -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell $site=Get-SPSite -Identity https://localhost Get-SPSiteUpgradeSessionInfo -Site $site @@ -62,13 +61,15 @@ This example returns siteupgradeinfo for every SPSite object returned from Get-S ## PARAMETERS ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the content database from which to list site collections.The type must be a valid database name, in the form SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,11 +79,13 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -HideWaiting + +> Applicable: SharePoint Server Subscription Edition + Specifies to hide site collections that upgrade has not started. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -ShowCompleted + +> Applicable: SharePoint Server Subscription Edition + Specifies to show site collections that has completed upgrade. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -ShowFailed + +> Applicable: SharePoint Server Subscription Edition + Specifies to show site collections that have failed upgrade. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -ShowInProgress + +> Applicable: SharePoint Server Subscription Edition + Displays site collections that are in the process of being upgraded. ```yaml Type: SwitchParameter Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies to limit the result to site collections within the site subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSolution.md index e4e8f6f94..d803687d7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPSolution.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a specified SharePoint solution. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPSolution ``` @@ -40,6 +39,9 @@ This example returns the collection of all installed SharePoint solutions in the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint solution to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplication.md index 6f5a63029..b0a9a4cea 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplication.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPStateServiceApplication ``` This example displays all state service applications in the farm. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPStateServiceApplication -Identity "StateServiceApp1" ``` @@ -44,6 +44,9 @@ This example displays a specific state service application in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to get. The type must be a valid name of a state service application (for example, StateServiceApp1) or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -52,7 +55,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplicationProxy.md index 59eee78fa..d9405239f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceApplicationProxy.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPStateServiceApplicationProxy ``` This example displays all the state service application proxies on the farm. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPStateServiceApplicationProxy -Identity 81dc50e0-c0f9-4d2c-8284-bb03bb1ea676 ``` @@ -44,6 +44,9 @@ This example displays a specific state service application proxy on the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application proxy to get. The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -52,7 +55,6 @@ The type must be a valid name of a state service application proxy (for example, Type: SPStateServiceApplicationProxyPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceDatabase.md index d1427334a..9d5adadc7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPStateServiceDatabase.md @@ -38,21 +38,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1---------------- +### EXAMPLE 1 ```powershell Get-SPStateServiceDatabase ``` This example displays all of the state service databases on the farm. -### --------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell Get-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example displays a specific state service database in the farm. -### --------------EXAMPLE 3-------------- +### EXAMPLE 3 ```powershell Get-SPStateServiceDatabase -ServiceApplication "StateServiceApp1" ``` @@ -62,6 +62,9 @@ This example displays all state service databases associated with a specific ser ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPStateServiceDatabase object (for example, StateSvcDB1). @@ -70,7 +73,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: Default Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -80,6 +82,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Filters to return only the state service database associated with the specified state service application. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -88,7 +93,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: ServiceApplication Aliases: Application -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +116,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTaxonomySession.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTaxonomySession.md index a60e05505..d9d279fac 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTaxonomySession.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTaxonomySession.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ```powershell $session = Get-SPTaxonomySession -Site "https://sitename" ``` @@ -37,6 +37,9 @@ This example retrieves a TaxonomySession object, which can be used to access ter ## PARAMETERS ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint site mapped to the set of metadata term stores for the taxonomy session. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPThrottlingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPThrottlingRule.md index 5f488b2bc..6e0d6dd64 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPThrottlingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPThrottlingRule.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all throttling rules. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -41,13 +40,15 @@ This example returns throttling rules for the farm by using the $rm and $web var ## PARAMETERS ### -RequestManagementSettings + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to return. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the throttling rule to return. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTimerJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTimerJob.md index 5e5920b7c..f6a9768e9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTimerJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTimerJob.md @@ -28,14 +28,14 @@ If no parameters are specified, this cmdlet returns all timer job definitions fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### ---------------------EXAMPLE 01--------------------- +### EXAMPLE 01 ```powershell Get-SPTimerJob -WebApplication "https://servername" | select Name, DisplayName ``` This example displays all timer jobs for a specified Web application. -### ---------------------EXAMPLE 02--------------------- +### EXAMPLE 02 ```powershell Get-SPTimerJob | select -ExpandProperty HistoryEntries ``` @@ -44,6 +44,9 @@ The above example will show you timer job run history ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the timer job to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +88,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Filters to return timer jobs of a specified type. The type must be a name of a valid timer job type; for example, TimerJob1. @@ -91,8 +98,7 @@ The type must be a name of a valid timer job type; for example, TimerJob1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +108,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Filters to return timer jobs defined for the scope of a specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -109,8 +118,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplication.md index a59323ffb..75080aef6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays properties of the topology service application for the current farm. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPTopologyServiceApplication ``` @@ -39,6 +38,9 @@ This example displays properties of the topology service application for the cur ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the application. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplicationProxy.md index 63685d1b9..8829d61ee 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTopologyServiceApplicationProxy.md @@ -14,7 +14,6 @@ schema: 2.0.0 Retrieves the topology service application proxy. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPTopologyServiceApplicationProxy ``` @@ -39,6 +38,9 @@ This example displays the topology service application proxy in the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the application proxy. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTranslationThrottlingSetting.md index cf764c81a..3cfacbc79 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTranslationThrottlingSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTranslationThrottlingSetting.md @@ -20,11 +20,11 @@ Get-SPTranslationThrottlingSetting [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ``yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +54,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -68,13 +72,15 @@ Accept wildcard characters: False ``` ### -Farm + +> Applicable: SharePoint Server Subscription Edition + Specifies the farm ```yaml Type: SPFarm Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +90,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -91,7 +100,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedIdentityTokenIssuer.md index c8194f352..231bfd3b9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedIdentityTokenIssuer.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns an identity provider. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ```powershell $trustedsts = Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" ``` @@ -39,6 +38,9 @@ This example gets a trusted identity token issuer. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity provider to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedRootAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedRootAuthority.md index cb6a10f46..16fe5a5f1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedRootAuthority.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a trusted root authority. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $rootauthority=Get-SPTrustedRootAuthority -Identity "WFEFarm1" ``` @@ -40,6 +39,9 @@ This example creates a new trusted root authority, WFEFarm1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted root authority to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedSecurityTokenIssuer.md index 2205ea75f..fa6bf0ca6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedSecurityTokenIssuer.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the trusted security token issuer object. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ```powershell Get-SPTrustedSecurityTokenService ``` @@ -41,14 +40,16 @@ This example displays all trusted security token service objects from the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the trusted security token issuer object that you want to return. If you do not specify this parameter, the cmdlet returns all the objects. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedServiceTokenIssuer.md index cb6551aa3..208c39ac9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPTrustedServiceTokenIssuer.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the object that represents the farm trust. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPTrustedServiceTokenIssuer "WFEFarm1" ``` @@ -39,6 +38,9 @@ This example gets the trusted services token issuer WFEFarm1. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted service token issuer to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUpgradeActions.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUpgradeActions.md index f99fac9b5..117faf24a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUpgradeActions.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUpgradeActions.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all upgrade actions. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE------------ +### EXAMPLE ```powershell Get-SPUpgradeActions ``` @@ -38,6 +37,9 @@ This example returns all upgrade actions within the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageApplication.md index 7ad2db3cd..138753c17 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a specified usage application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPUsageApplication -Identity "Usage and Health data collection" ``` @@ -40,6 +39,9 @@ This example returns the usage application named, Usage and Health data collecti ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage application to get. If the Identity parameter is not specified, the cmdlet returns the local usage application. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server Subscription Edition + Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -88,8 +94,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageDefinition.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageDefinition.md index ed27d2c6f..620935e11 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageDefinition.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageDefinition.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a usage definition object. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPUsageDefinition -Identity "Page Requests" ``` @@ -41,6 +40,9 @@ This example returns the SPRequestUsage provider on the local farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage definition object to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageService.md index 9d95ad2f3..777f275ab 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUsageService.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a usage service. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE------------------------- +### EXAMPLE ```powershell Get-SPUsageService -Identity 57055d99-9914-4af6-a3bf-7b76e3f231c2 ``` @@ -40,6 +39,9 @@ This example returns a SPUsageService object of the specified ID. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage service to get. If the Identity parameter is not specified, the cmdlet returns the local usage service. @@ -48,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +74,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUser.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUser.md index 503c37e5b..db5297e49 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUser.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUser.md @@ -14,8 +14,7 @@ schema: 2.0.0 Returns the user account or accounts that match a given search criteria. - -## SYNTAX +## SYNTAX ``` Get-SPUser [[-Identity] ] -Web [-AssignmentCollection ] @@ -31,22 +30,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPUser -Web 'https://sharepoint.contoso.com' -Group 'Viewers' ``` This example returns all members of the SharePoint group Viewers on the site https://sharepoint.contoso.com. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPUser -Identity 'i:0#.w|contoso\jdoe' -Web 'https://sharepoint.contoso.com' ``` This example returns the specific user identified via Windows Claims on the site https://sharepoint.contoso.com. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Get-SPUser -Identity 'contoso\jdoe' -Web 'https://sharepoint.contoso.com' ``` @@ -56,6 +54,9 @@ This example returns the specific user identified via Classic Windows authentica ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID or login name of the user to be returned. The type must be a valid ID or login name, such as the format of 'CONTOSO\jdoe' for Classic Windows Authentication or 'i:0#.w|CONTOSO\jdoe' for Windows Claims. @@ -64,7 +65,6 @@ The type must be a valid ID or login name, such as the format of 'CONTOSO\jdoe' Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -74,6 +74,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web site to be used as a scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Foundation Web site (for example, MySPSite1); or an instance of a valid SPWeb object. @@ -81,8 +84,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -92,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +108,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server Subscription Edition + Specifies the user group to which the new user belongs. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,14 +136,16 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of users to return. The default value is 500. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicense.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicense.md index cb3d4dc98..c996152c9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicense.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicense.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the list of supported SharePoint user licenses. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE------------------- +### EXAMPLE ```powershell Get-SPUserLicense ``` @@ -38,6 +37,9 @@ This example returns the list of supported SharePoint user licenses for the Shar ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicenseMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicenseMapping.md index 03858f434..a3b9ef2f8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicenseMapping.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the claim-to-user license mappings. - ## SYNTAX ``` @@ -34,21 +33,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPUserLicenseMapping ``` This example returns all claim-to-user license mappings for the entire SharePoint farm. -### ---------------EXAMPLE 2 ----------------- +### EXAMPLE 2 ```powershell Get-SPUserLicenseMapping -WebApplication "SharePoint - 80" ``` This example returns all claim-to-user license mappings for the web application with the name "SharePoint - 80". -### ---------------EXAMPLE 3 ----------------- +### EXAMPLE 3 ```powershell Get-SPUserLicenseMapping -WebApplication https:///sitename ``` @@ -58,6 +57,9 @@ This example returns all claim-to-user license mappings for the Web application ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,14 +81,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, web application name, or instance of a web application object from which to get the user license mappings. The type must be an URL in the form https://server_name or https://server_name/sites/sitename, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh), a web application name (that is, SharePoint - 80), or an instance of a web application object. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicensing.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicensing.md index a28f50b4c..6d78b1f45 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicensing.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserLicensing.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the state of user-license enforcement. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPUserLicensing ``` @@ -41,6 +40,9 @@ This example returns the state of user-license enforcement on the SharePoint far ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +54,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProvider.md index 1fa694a83..411fb9509 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a list of User Settings Providers installed on the farm. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE-------- +### EXAMPLE ```powershell $provider = Get-SPUserSettingsProvider $site = Get-SPSite -Identity https://someserver @@ -45,13 +44,15 @@ This example returns the regional settings for a specified user. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID ID for a User Settings Provider. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProviderManager.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProviderManager.md index 247865185..6bbd579d9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProviderManager.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSettingsProviderManager.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the User Settings Provider Manager. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE-------- +### EXAMPLE ```powershell Get-SPUserSettingsProviderManager ``` @@ -38,6 +37,9 @@ This example returns the User Settings Provider Manager for the farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolution.md index cc2dca14e..e8994d22c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolution.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a specified sandboxed solution. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE--------------------- +### EXAMPLE ```powershell Get-SPUserSolution -Site https://sitename ``` @@ -41,6 +40,9 @@ This example displays information about sandboxed solutions in the site https:// ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution to get. The type must be a valid name of a user solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -48,8 +50,7 @@ The type must be a valid name of a user solution (for example, UserSolution1); o ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection that contains the sandboxed solution. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -66,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolutionAllowList.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolutionAllowList.md index b8b6c2c6c..036f2f5c3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPUserSolutionAllowList.md @@ -24,7 +24,7 @@ Gets the user managed solutions gallery configured on the specified web applicat ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPUserSolutionAllowList -WebApplication https://webAppUrl ``` @@ -33,6 +33,9 @@ This example gets the user managed solutions gallery on the web application with ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -51,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,13 +71,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the web application to search for the user solution allow list. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,6 +89,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -90,7 +99,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioExternalData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioExternalData.md index 523e138d4..06a22aa8b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioExternalData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioExternalData.md @@ -26,14 +26,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ```powershell Get-SPVisioExternalData -VisioServiceApplication "VGS1" ``` This example gets settings related to external data for a Visio Services application. -### ------------------EXAMPLE 2------------------------ +### EXAMPLE 2 ```powershell Get-SPVisioServiceApplication -identity "VGS1" | Get-SPVisioExternalData ``` @@ -43,6 +43,9 @@ This example uses a pipe bind to get settings related to external data for a Vis ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioExternalData object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -50,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +77,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioPerformance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioPerformance.md index 7488d8b62..529c56680 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioPerformance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioPerformance.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------------- +### EXAMPLE ```powershell Get-SPVisioPerformance -VisioServiceApplication "VGS1" ``` @@ -36,6 +36,9 @@ This example gets settings related to performance for a Visio Services applicati ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioPerformance object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -43,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioSafeDataProvider.md index 555506277..7f64cbb01 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioSafeDataProvider.md @@ -28,14 +28,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" ``` This example returns a list of safe data providers for a specific Visio Services application. -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 ``` @@ -45,6 +45,9 @@ This example returns information about a specified safe data provider for a spec ## PARAMETERS ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -52,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +79,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -DataProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies the safe data provider to get. The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Graphics Service application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -94,8 +101,7 @@ The type must be a valid string that identifies the data provider; for example, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -105,6 +111,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server Subscription Edition + Specifies the supported type of the data provider to get. Custom data types are supported; for example, Excel services. @@ -113,8 +122,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplication.md index 6e586281c..b5e188f0c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplication.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1------------------------- +### EXAMPLE 1 ```powershell Get-SPVisioServiceApplication ``` This example returns a collection of all Visio Services applications in the farm. -### -----------------------EXAMPLE 2------------------------- +### EXAMPLE 2 ```powershell Get-SPVisioServiceApplication "VGS1" ``` @@ -44,6 +44,9 @@ This example returns properties of the VGS1 Visio Services application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplicationProxy.md index e81e29ee0..5bb386e07 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPVisioServiceApplicationProxy.md @@ -27,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Get-SPVisioServiceApplicationProxy ``` This example returns a list of Visio Services application proxies. -### ----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Get-SPVisioServiceApplicationProxy "Connection to VGS2" ``` @@ -44,6 +44,9 @@ This example returns settings for a Visio Services application proxy. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application proxy to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -51,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +78,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIBinding.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIBinding.md index bcabf22c3..4dd02c0bc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIBinding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIBinding.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns a list of bindings that were created by using New-SPWOPIBinding on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -30,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPWOPIBinding -Server "Server.corp.Contoso.com" ``` This example returns a list of bindings that were created on the current SharePoint farm where this cmdlet is run for the WOPI application "Server.corp.Contoso.com." The WOPI application may be the server that runs Office Web Apps Server. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPWOPIZone | Get-SPWOPIBinding ``` @@ -47,13 +46,15 @@ This example returns a list of bindings that were created on the current SharePo ## PARAMETERS ### -Action + +> Applicable: SharePoint Server Subscription Edition + Specifies the action to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server Subscription Edition + Specifies the application to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extension to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server Subscription Edition + Specifies the programmatic identifier (ProgID) for an application to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of WOPI application (such as a server that runs Office Web Apps Server) to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WOPIZone + +> Applicable: SharePoint Server Subscription Edition + Specifies the zone to return bindings for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPISuppressionSetting.md index fe71cd1df..6757ad13e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPISuppressionSetting.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the suppression settings on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPWOPISuppressionSetting ``` @@ -39,6 +38,9 @@ The suppression settings returned include the DocType and WOPIAction. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIZone.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIZone.md index ba6ce93bf..91e624bd2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIZone.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWOPIZone.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the zone that is configured on the current SharePoint farm for the WOPI application to use. - ## SYNTAX ``` @@ -28,17 +27,20 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPWOPIZone ``` -This example returns the zone that is configured for the WOPI application (such as a server that runs Office Web Apps Server) to use. +This example returns the zone that is configured for the WOPI application (such as a server that runs Office Web Apps Server) to use. Return values may be "internal-http," "internal-https," "external-http" or "external-https." ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWeb.md index 5be123b62..4bc1246e5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWeb.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all subsites that match the given criteria. - ## SYNTAX ``` @@ -33,7 +32,7 @@ The Identity parameter also supports providing a partial URL that ends in a wild All subsites that match this partial URL for the specified scope are returned. Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any subweb with a URL provided in the given scope that matches the expression is returned. -The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. +The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. These subsite properties are Template and Title. The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run server-side for faster results. @@ -44,21 +43,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Get-SPWeb -site https://sitename/sites/site1 ``` This example returns all the subwebs in a given site collection. -### --------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPWeb -Site https://sitename/sites/site1 -filter {$_.Template -eq "STS#0"} ``` This example displays all subsites that use the "STS#0" template. -### --------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ```powershell Start-SPAssignment -Global $w = Get-SPWeb https://sitename @@ -72,6 +71,9 @@ This example demonstrates how to save a subsite as a variable and to call object ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or full or partial URL of the subsite. If you use a relative path, you must specify the Site parameter. @@ -80,8 +82,7 @@ A valid URL in the form https://server_name or a relative path in the form of /S ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +106,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,6 +135,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server Subscription Edition + Specifies the server-side filter to use for the specified scope. The type must be a valid filter in the form {filterName \ "filterValue"}. @@ -137,8 +145,7 @@ The type must be a valid filter in the form {filterName \ "filterValu ```yaml Type: ScriptBlock Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +155,9 @@ Accept wildcard characters: False ``` ### -Limit + +> Applicable: SharePoint Server Subscription Edition + Limits the maximum number of subsites to return. The default value is 200. To return all sites, enter ALL @@ -157,8 +167,7 @@ The type must be a valid number greater than 0 or ALL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,13 +177,15 @@ Accept wildcard characters: False ``` ### -Regex + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL that is provided by the Identity parameter is treated as a regular expression. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection from which to list subsites. The type must be a valid URL, in the form of https://server_name; a GUID, in the form 1234-5678-9807, or an SPSite object. @@ -191,8 +205,7 @@ The type must be a valid URL, in the form of https://server_name; a GUID, in th ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -209,7 +225,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplication.md index bcc16355e..33ee61ed6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all Web applications that match the given criteria. - ## SYNTAX ``` @@ -33,14 +32,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell $w = Get-SPWebApplication https://sitename ``` This example gets the Web application for https://sitename and stores it in a variable. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPWebApplication -IncludeCentralAdministration | Where { $_.DefaultServerComment -eq "SharePoint Central Administration v4"} | Format-List * ``` @@ -50,6 +49,9 @@ This example displays all public properties on the SharePoint Central Administra ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application. The type must be a valid URL, in the form https://server_name; a GUID, in the form 1234-5678-9876-0987; or a valid name, in the form SPWebApplication - 1212. @@ -57,8 +59,7 @@ The type must be a valid URL, in the form https://server_name; a GUID, in the fo ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -68,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +83,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,14 +93,16 @@ Accept wildcard characters: False ``` ### -IncludeCentralAdministration + +> Applicable: SharePoint Server Subscription Edition + Includes the Central Administration Web application in the collection of Web applications that can be returned. The IncludeCentral Administration parameter must still meet any other filters provided. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationAppDomain.md index 0892a0369..94b944de8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationAppDomain.md @@ -35,28 +35,28 @@ Use the Get-SPWebApplicationAppDoman cmdlet to return all app domains for a spec ## EXAMPLES -### -----------EXAMPLE 1--------- +### EXAMPLE 1 ```powershell Get-SPWebApplicationAppDomain ``` Returns a list of SPAppDomain objects, one for each of the app domains for all web applications in the farm. -### -----------EXAMPLE 2--------- +### EXAMPLE 2 ```powershell Get-SPWebApplicationAppDomain -Zone Default ``` Returns a list of SPAppDomain objects, one for each of the app domains for the Default zone for all web applications in the farm. -### -----------EXAMPLE 3--------- +### EXAMPLE 3 ```powershell Get-SPWebApplicationAppDomain -WebApplication https://www.contoso.com ``` Returns a list of SPAppDomain objects, one for each of all the app domains for the specified web application for all zones. -### -----------EXAMPLE 4--------- +### EXAMPLE 4 ```powershell Get-SPWebApplicationAppDomain -AppDomain contosoapps.com ``` @@ -67,13 +67,14 @@ Returns a list of SPAppDomain objects, one for each web application and zone pai ### -Identity +> Applicable: SharePoint Server Subscription Edition + Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object. ```yaml Type: SPAppDomainPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -84,13 +85,14 @@ Accept wildcard characters: False ### -AppDomain +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the app domain. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,13 +103,14 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID, URI, or name of the web application for which the app domain is being configured. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,6 +121,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -125,8 +130,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,6 +141,8 @@ Accept wildcard characters: False ### -Zone +> Applicable: SharePoint Server Subscription Edition + Specifies the security zone to which the app domain will be assigned. * Default @@ -154,8 +160,7 @@ If no value is specified, Default is applied. ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationHttpThrottlingMonitor.md index 896e84e73..3d368f412 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationHttpThrottlingMonitor.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebApplicationHttpThrottlingMonitor.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns all counters and their associated Health Score bucket values for network throttling on a Web application. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $s = get-SPWebApplicationHTTPThrottlingMonitor https://sharepoint ``` @@ -40,6 +39,9 @@ This example gets all performance counters that are being read in the network th ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Returns throttling performance counter settings for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebPartPack.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebPartPack.md index a33b64c88..be247d8e2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebPartPack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebPartPack.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns the Web Part packages that were installed for the specified scope. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPWebPartPack -WebApplication http://zsharepoint2:80 ``` @@ -42,6 +41,9 @@ This example returns all Web Part packages that have been installed on the Web a ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the full or partial name of the Web Part package from the configuration database. The type must be a valid name of a Web Part package; for example, MyWebPartPackage. @@ -49,8 +51,7 @@ The type must be a valid name of a Web Part package; for example, MyWebPartPacka ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +75,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,13 +85,15 @@ Accept wildcard characters: False ``` ### -GlobalOnly + +> Applicable: SharePoint Server Subscription Edition + Returns only Web Part packages that are installed in the global assembly cache (GAC). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,14 +103,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application from which to list Web Part packages. If no Web application is specified, the specified Web Part packages will be returned from all Web applications. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplate.md index cccccb892..5c978a358 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplate.md @@ -14,7 +14,6 @@ schema: 2.0.0 Displays all globally installed site templates that match the given identity. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell $template = Get-SPWebTemplate "STS#0" New-SPSite https://contoso.com -OwnerAlias "DOMAIN\JDOE" -Template $template @@ -37,7 +36,7 @@ New-SPSite https://contoso.com -OwnerAlias "DOMAIN\JDOE" -Template $template This example creates a site collection by using the team site Web template (ID=STS#0). -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPWebTemplate "STS*" ``` @@ -47,6 +46,9 @@ This example displays basic information about all the STS templates. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Web template to display. The type must be the ID or full or partial name of the Web template. @@ -54,8 +56,7 @@ The type must be the ID or full or partial name of the Web template. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be either SharePoint Server or SharePoint Server. @@ -95,8 +101,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplatesEnabledForSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplatesEnabledForSiteMaster.md index 525f1ff14..9ae365b7d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplatesEnabledForSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWebTemplatesEnabledForSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/get-spwebtemplatesenabledforsitemaster -Applicable: SharePoint Server Subscription Edition + title: Get-SPWebTemplatesEnabledForSiteMaster schema: 2.0.0 --- @@ -23,7 +23,7 @@ Use the Get-SPWebTemplatesEnabledForSiteMaster cmdlet to display a full list of ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPWebTemplatesEnabledForSiteMaster ``` @@ -33,6 +33,9 @@ This example displays all the site master web templates in a farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowConfig.md index 520f61e19..f5f5f5594 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Returns workflow settings for the specified Web application. - ## SYNTAX ### SiteCollection @@ -40,7 +39,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPWorkFlowConfig -webapplication https://sitename ``` @@ -52,6 +51,9 @@ To get farm-level workflow settings for event delivery time-out, postpone thresh ## PARAMETERS ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or URL of the site collection. The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. @@ -60,8 +62,7 @@ No other parameters are used. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -71,6 +72,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or URL of the Web application. The type must be a valid name, in the form WebApplication-1212, or a URL, in the form https://server_name/WebApplication-1212. @@ -78,8 +82,7 @@ The type must be a valid name, in the form WebApplication-1212, or a URL, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +106,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowServiceApplicationProxy.md index 4acd75371..f9be72893 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPWorkflowServiceApplicationProxy.md @@ -24,7 +24,7 @@ Returns the Workflow Service Application Proxy. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Get-SPWorkflowServiceApplicationProxy ``` @@ -33,6 +33,9 @@ Returns the Workflow Service Application Proxy. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -51,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,6 +71,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -74,7 +81,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPBusinessDataCatalogMetadataObject.md index 5d3ff98ff..9a61f580b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPBusinessDataCatalogMetadataObject.md @@ -14,7 +14,6 @@ schema: 2.0.0 Grants a right to a principal for the specified Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName $Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -ServiceContext http://contoso -Name "ContosoModel" @@ -43,13 +42,15 @@ This example gives Edit permissions to the user with the identity johndoe on dom ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the principal to whom the rights apply. The type must be a claim. @@ -66,8 +70,7 @@ The type must be a claim. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server Subscription Edition + Specifies the right to grant the principal. The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. @@ -84,8 +90,7 @@ The type must be one of the following valid PSBdcRight object types: All, Execut ```yaml Type: PSBdcRight Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server Subscription Edition + Specifies the model slice for which to grant the right. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -141,8 +153,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +173,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPObjectSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPObjectSecurity.md index 3f4e8a851..9a8e71d7c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPObjectSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Grant-SPObjectSecurity.md @@ -14,7 +14,6 @@ schema: 2.0.0 Adds a new security principal to an SPObjectSecurity object. - ## SYNTAX ``` @@ -30,9 +29,9 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell -$principal = New-SPClaimsPrincipal "CONTOSO\JaneDoe" -IdentityType WindowsSamAccountName +$principal = New-SPClaimsPrincipal "CONTOSO\JaneDoe" -IdentityType WindowsSamAccountName $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} $security = Get-SPServiceApplicationSecurity $sa -Admin Grant-SPObjectSecurity $security $principal "Full Control" @@ -46,14 +45,16 @@ The new user is an administrator for the service application $serviceApp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPObjectSecurity object to which the new security principal is added. You can use the Get-SPServiceApplicationSecurity cmdlet to get a SPObjectSecurity object . ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the principal to whom the rights apply. The type must a valid name a principal; for example, Full Control. @@ -70,8 +74,7 @@ The type must a valid name a principal; for example, Full Control. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Rights + +> Applicable: SharePoint Server Subscription Edition + Specifies the rights granted to the principal. The type must a valid array of strings that represents the rights granted to the principal. @@ -88,8 +94,7 @@ The type must a valid array of strings that represents the rights granted to the ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +118,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,14 +128,16 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server Subscription Edition + Replaces the existing rights on the SPObjectSecurity object with the new rights specified. If this parameter is not specified, the new rights are added to the existing rights. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPAppPackage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPAppPackage.md index 0b275cee3..90a3d2128 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPAppPackage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPAppPackage.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE---------- +### EXAMPLE ```powershell Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) ``` @@ -37,13 +37,15 @@ This example imports an app package. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the input file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -Source + +> Applicable: SharePoint Server Subscription Edition + Defines the source of the app. The source indicates where the app package originates from, for example, if the app was built by a developer but did not reside on the SharePoint Marketplace, you might use the CorporateCatalog source. The following are valid values: @@ -66,13 +71,11 @@ The following are valid sources (not parameters of -Source) of the app: --App catalog (CorporateCatalog) --SharePointService - Indicates apps that were built in place with SharePoint features, for example Access Services (ObjectModel) - ```yaml Type: SPAppSource Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -121,6 +128,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -AssetId + +> Applicable: SharePoint Server Subscription Edition + Specifies the Asset Id to import. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,13 +165,15 @@ Accept wildcard characters: False ``` ### -ContentMarket + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the content market. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,13 +183,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPSite object to import. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogDotNetAssembly.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogDotNetAssembly.md index 58d31f19c..90a5e59d3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogDotNetAssembly.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogDotNetAssembly.md @@ -14,7 +14,6 @@ schema: 2.0.0 Imports a .NET Connectivity assembly. - ## SYNTAX ``` @@ -30,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1---------------- +### EXAMPLE 1 ```powershell Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" ``` This example imports the assembly Assembly. -### -----------------EXAMPLE 2---------------- +### EXAMPLE 2 ```powershell Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" -DependentAssemblyPaths "c:\Folder\Assembly2.dll","c:\Folder\Assembly3.dll" ``` @@ -47,13 +46,15 @@ This example imports the assembly Assembly, and also imports the dependent assem ## PARAMETERS ### -LobSystem + +> Applicable: SharePoint Server Subscription Edition + Specifies the LobSystem that the assembly corresponds to. ```yaml Type: LobSystem Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -63,13 +64,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path to the primary assembly. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,13 +125,15 @@ Accept wildcard characters: False ``` ### -DependentAssemblyPaths + +> Applicable: SharePoint Server Subscription Edition + Specifies a list of paths to dependent assemblies. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogModel.md index bcaaaa221..2ea5dc242 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPBusinessDataCatalogModel.md @@ -40,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $MetadataStore = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Catalog" -ServiceConext https://contoso Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $MetadataStore @@ -48,7 +48,7 @@ Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $Metada This example gets the Business Data Connectivity Metadata Store and then imports a Business Data Connectivity Model of Model type to it from the path specified with the name model. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Import-SPBusinessDataCatalogModel -Path "C:\Program Files\Duet Enterprise\2.0\BDC Models\Reporting.en-us.bdcr -Identity $bdcCatalog -ModelsIncluded:$false ``` @@ -58,13 +58,15 @@ This example imports a resource only file by using the ModelsIncluded parameter. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object to import to. ```yaml Type: MetadataObject Parameter Sets: Catalog -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +76,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name to use. The type must be a valid path in either of the following forms: @@ -85,8 +90,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -135,13 +143,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites the Business Data Connectivity Model if the file exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,13 +161,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that names for business data fields in multiple languages are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,14 +179,16 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that models are included in the imported Business Data Connectivity Model file. A model contains the base XML metadata for a system. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,13 +198,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that permissions from the Business Data Connectivity Model are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,13 +216,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that properties from the Business Data Connectivity Model are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,6 +234,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom environment settings model slice to import. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -223,8 +244,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -234,6 +254,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -241,7 +264,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -251,13 +273,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context to set. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCacheClusterConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCacheClusterConfig.md index 2ae42fc8e..a79b181f7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCacheClusterConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCacheClusterConfig.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Import-SPCacheClusterConfig -Path C:\Config.txt ``` @@ -36,6 +36,9 @@ This example imports cache cluster configuration details from C:\Config.txt. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,7 +51,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the imported file. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -97,7 +106,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCertificate.md index 23ae8b5da..dd80cd2a2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPCertificate.md @@ -35,17 +35,17 @@ Uninstalling SharePoint from a server will not automatically remove SharePoint-m ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell -$password = ConvertTo-SecureString -AsPlainText -Force - +$password = ConvertTo-SecureString -AsPlainText -Force + Import-SPCertificate -Path "\\server\fileshare\certificates.pfx" -Password $password -Exportable ``` This example imports certificates and any associated private keys from the \\\\server\fileshare\certificates.pfx file into the SharePoint farm. It also allows private keys that were imported during this operation to be exported from SharePoint in the future. -### ------------EXAMPLE 2----------- +### EXAMPLE 2 ```powershell Import-SPCertificate -Path D:\test.cer ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchCustomExtractionDictionary.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchCustomExtractionDictionary.md index eb276cb7f..817d5801a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchCustomExtractionDictionary.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchCustomExtractionDictionary.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $searchApp = Get-SPEnterpriseSearchServiceApplication Import-SPEnterpriseSearchCustomExtractionDictionary -SearchApplication $searchApp -Filename c:\transfer\entity_extraction.csv -DictionaryName Microsoft.UserDictionaries.EntityExtraction.Custom.Word.1 @@ -41,6 +41,9 @@ The entries of this dictionary will be matched in a case-insensitive way against ## PARAMETERS ### -DictionaryName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the target dictionary. The name must be one of the following 12 predefined dictionaries. The name signifies the "case sensitivity" and "token matching" behavior. @@ -48,8 +51,7 @@ The name signifies the "case sensitivity" and "token matching" behavior. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,15 +62,15 @@ Accept wildcard characters: False ### -FileName -Specifies the file path of the .cvs file to be imported +> Applicable: SharePoint Server Subscription Edition +Specifies the file path of the .cvs file to be imported ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,15 +81,15 @@ Accept wildcard characters: False ### -SearchApplication -Specifies the search service application to which the custom extraction dictionary should be imported. +> Applicable: SharePoint Server Subscription Edition +Specifies the search service application to which the custom extraction dictionary should be imported. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchPopularQueries.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchPopularQueries.md index 52ae3ab3e..fcde5bd48 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchPopularQueries.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchPopularQueries.md @@ -56,7 +56,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $ssap = Get-SPEnterpriseSearchServiceApplicationProxy $hostname = hostname @@ -73,14 +73,16 @@ The example defines the variable $web as the SPWeb with URL https://hostname, an ## PARAMETERS ### -ResultSource + +> Applicable: SharePoint Server Subscription Edition + Specifies the Result Source to associate with the imported queries. The type must be an instance of a valid Source object. ```yaml Type: Source Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,14 +92,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy for the search application to which the queries file should be imported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,14 +111,16 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWeb to associate with the imported queries. The type must be an instance of a valid SPWeb object. ```yaml Type: SPWeb Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -124,6 +130,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -135,8 +144,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +164,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,13 +173,15 @@ Accept wildcard characters: False ``` ### -Filename + +> Applicable: SharePoint Server Subscription Edition + Specifies the full UNC (Universal Naming Convention) path of the file to import. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -186,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchThesaurus.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchThesaurus.md index a05011cec..cd9789b68 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchThesaurus.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchThesaurus.md @@ -30,10 +30,10 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell -$searchApp = Get-SPEnterpriseSearchServiceApplication -Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename +$searchApp = Get-SPEnterpriseSearchServiceApplication +Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename \\host\share\thesaurus.csv ``` @@ -42,13 +42,15 @@ This example imports a thesaurus dictionary .csv file named thesaurus.csv that i ## PARAMETERS ### -FileName + +> Applicable: SharePoint Server Subscription Edition + Specifies the full UNC (Universal Naming Convention) path of the .csv file to be imported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which the thesaurus dictionary should be imported ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchTopology.md index 3d1885d29..97814a10c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPEnterpriseSearchTopology.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Import-SPEnterpriseSearchTopology -SearchApplication $ssa -Filename .\topology.xml @@ -38,6 +38,9 @@ This example imports a topology from a file named topology.xml to the default se ## PARAMETERS ### -Filename + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and file name of the topology XML file to import. The type must be a valid path, in the form MyFeature\Feature.xml. @@ -45,8 +48,7 @@ The type must be a valid path, in the form MyFeature\Feature.xml. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which to apply the topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -63,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPInfoPathAdministrationFiles.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPInfoPathAdministrationFiles.md index d4de8a45c..9abdfe1e2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPInfoPathAdministrationFiles.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPInfoPathAdministrationFiles.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Import-SPInfoPathAdministrationFiles -path "backupfiles.cab" ``` @@ -37,6 +37,9 @@ This example imports form templates (XSN files) and universal data connections ( ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the location of the .cab file to import. The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfsfiles.cab. @@ -44,8 +47,7 @@ The type must be a valid file path, in the form \\\\ipadmin\folder\backups1\ipfs ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the destination InfoPath Forms Services service for the import. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a forms service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -101,8 +110,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPMetadataWebServicePartitionData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPMetadataWebServicePartitionData.md index eb4183331..3e9d7b47f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPMetadataWebServicePartitionData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPMetadataWebServicePartitionData.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE---------------------- +### EXAMPLE ```powershell $subscription = Get-SPSiteSubscription -Identity https://site_url $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Managed Metadata Service Connection'} @@ -40,6 +40,9 @@ This example restores a backup of Metadata Service application data for a specif ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription to import. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -47,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy for the service application that contains the site subscription. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name of the subscription data file to import. The type must be a valid path in either of the following forms: @@ -86,8 +93,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +117,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,13 +127,15 @@ Accept wildcard characters: False ``` ### -OverwriteExisting + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to overwrite the existing site subscription data, if it exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,13 +145,15 @@ Accept wildcard characters: False ``` ### -NoCompression + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,13 +163,15 @@ Accept wildcard characters: False ``` ### -ToContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,13 +181,15 @@ Accept wildcard characters: False ``` ### -ToServiceDatabase + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPScaleOutDatabaseTenantData.md index dbdb070ee..e280252ff 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPScaleOutDatabaseTenantData.md @@ -14,7 +14,6 @@ schema: 2.0.0 Imports data from the specified subscription id. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ```powershell Import-SPScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` @@ -40,6 +39,9 @@ This example imports data from the file at C:\TenantData.dat, to the specified s ## PARAMETERS ### -FilePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the absolute path to the data file. An absolute path includes the root directory and all sub-directories. @@ -47,8 +49,7 @@ An absolute path includes the root directory and all sub-directories. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to import the data to. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,14 +77,16 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription id to import the data from. This value will replace the site subscription id value from the data file. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPServerScaleOutDatabaseTenantData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPServerScaleOutDatabaseTenantData.md index 2da3dabb9..175c3b0fb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPServerScaleOutDatabaseTenantData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPServerScaleOutDatabaseTenantData.md @@ -27,30 +27,29 @@ Use the Import-SPServerPScaleOutDatabaseTenantData cmdlet to import data from th ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ```powershell Import-SPServerScaleOutDatabaseTenantData -FilePath "C:\TenantData.dat" -ServiceApplication $serviceApplication -SiteSubscriptionId "5CAF2F99-A75F-4239-B9CD-7FE63D1CE904" ``` This example imports data from the file at C:\TenantData.dat, to the specified service application and marks all the imported data with the site subscription id 5CAF2F99-A75F-4239-B9CD-7FE63D1CE904. - ## PARAMETERS ### -FilePath +> Applicable: SharePoint Server Subscription Edition + Specifies the absolute path to the data file. An absolute path includes the root directory and all sub-directories. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,13 +60,14 @@ Accept wildcard characters: False ### -ServiceApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to import the data to. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,14 +78,15 @@ Accept wildcard characters: False ### -SiteSubscriptionId +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription id to import the data from. This value will replace the site subscription id value from the data file. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,6 +97,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +121,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,6 +140,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md index 863e5a1a6..cf9ee69f5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -14,7 +14,6 @@ schema: 2.0.0 Imports data associated with an exported file that contains all data associated with the Business Data Connectivity Metadata Store for a given partition. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE--------------------------- +### EXAMPLE ```powershell Import-SPSiteSubscriptionBusinessDataCatalogConfig -Path "C:\folder\importFile.xml" -ServiceContext http://contoso ``` @@ -40,6 +39,9 @@ This example imports the data file named importFile.xml. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name to use to create the export file.The type must be a valid path in either of the following forms: C:\folder_name @@ -51,8 +53,7 @@ C:\folder_name ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context of the data to be exported. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -69,8 +73,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +97,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalizedNamesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that names for business data fields in multiple languages be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,13 +144,15 @@ Accept wildcard characters: False ``` ### -ModelsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that Business Data Connectivity models be included in the imported file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,13 +162,15 @@ Accept wildcard characters: False ``` ### -PermissionsIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that permissions from the Business Data Connectivity model be exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,13 +180,15 @@ Accept wildcard characters: False ``` ### -PropertiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that properties from the Business Data Connectivity model be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -183,13 +198,15 @@ Accept wildcard characters: False ``` ### -ProxiesIncluded + +> Applicable: SharePoint Server Subscription Edition + Specifies that proxies for Business Data Connectivity Service Applications be exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,6 +216,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -206,7 +226,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionSettings.md index e1dff72cd..2ec1c2433 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPSiteSubscriptionSettings.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell $subscription = Get-SPSiteSubscription https://site_url Import-SPSiteSubscriptionSettings -Identity $subscription -Path "C:\backups\contoso_settings_file.bak" -Force @@ -39,6 +39,9 @@ This example restores the subscription settings store of contoso.com. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the subscription to restore . The type must be a valid URL, in the form https://site_url, or a GUID, in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. @@ -46,8 +49,7 @@ The type must be a valid URL, in the form https://site_url, or a GUID, in the fo ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the location of the input file. The type must be a valid path, in the form C:\filename.bak. @@ -64,8 +69,7 @@ The type must be a valid path, in the form C:\filename.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,14 +79,16 @@ Accept wildcard characters: False ``` ### -AdminProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies that only administrator subscription properties are imported. If this parameter is not set, only non-administrator subscription properties are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +112,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -131,13 +141,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + If a setting key already exists, determines whether the value must be overwritten with the value in the backup file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -147,6 +159,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -154,7 +169,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPWeb.md index 965a6089a..dd5066ca5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Import-SPWeb.md @@ -14,7 +14,6 @@ schema: 2.0.0 Imports a web, list, or library. - ## SYNTAX ``` @@ -33,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE---------------------- +### EXAMPLE ```powershell Import-SPWeb https://site -Path export.cmp -UpdateVersions Overwrite ``` @@ -43,6 +42,9 @@ This example imports the contents of export.cmp into a site at https://site, ove ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the Web to import into. The type must be a valid URL, GUID, or object; for example, a valid URL, in the form https://server_name, or a GUID, in the form, 1234-4567-5678a. @@ -50,8 +52,7 @@ The type must be a valid URL, GUID, or object; for example, a valid URL, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the import file. If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid. @@ -68,8 +72,7 @@ If the NoFileCompression parameter is used, a directory must be specified; other ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -ActivateSolutions + +> Applicable: SharePoint Server Subscription Edition + Specifies whether user solutions are activated during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + This parameter has no function in this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -HaltOnError + +> Applicable: SharePoint Server Subscription Edition + Stops the import process when an error occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -HaltOnWarning + +> Applicable: SharePoint Server Subscription Edition + Stops the import process when a warning occurs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -IncludeUserCustomAction + +> Applicable: SharePoint Server Subscription Edition + Specifies whether User Custom Actions are included during import. Valid values are: @@ -191,8 +209,7 @@ All, None ```yaml Type: SPIncludeUserCustomAction Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -203,13 +220,14 @@ Accept wildcard characters: False ### -IncludeUserSecurity +> Applicable: SharePoint Server Subscription Edition + Preserves the user security settings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -219,6 +237,9 @@ Accept wildcard characters: False ``` ### -NoFileCompression + +> Applicable: SharePoint Server Subscription Edition + Either enables or disables file compression in the import package. The import package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. @@ -227,8 +248,7 @@ If compression is enabled, the import process can increase by approximately 30 p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -238,6 +258,9 @@ Accept wildcard characters: False ``` ### -NoLogFile + +> Applicable: SharePoint Server Subscription Edition + Suppresses the generation of an import log file. If this parameter is absent, the Import-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS). @@ -248,8 +271,7 @@ However, for performance reasons, you might not want to generate a log file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -259,6 +281,9 @@ Accept wildcard characters: False ``` ### -UpdateVersions + +> Applicable: SharePoint Server Subscription Edition + Indicates how to resolve situations where a file to be imported to a site already exists in that site. If the UpdateVersions parameter is absent, the import operation by default uses a value of 1 (Append). @@ -279,8 +304,7 @@ Append, Ignore, Overwrite ```yaml Type: SPUpdateVersions Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -290,6 +314,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -297,7 +324,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -307,13 +333,15 @@ Accept wildcard characters: False ``` ### -PreserveDeletedUserMetadataReferences + +> Applicable: SharePoint Server Subscription Edition + Attempts to opulates the 'Author' ('Created By') field for items even if the SPUser object was marked as deleted on the destination site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPResourceSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPResourceSecurity.md index fc67be213..f04928f8c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPResourceSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPResourceSecurity.md @@ -14,7 +14,6 @@ schema: 2.0.0 Enforces resource security on the local server. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Initialize-SPResourceSecurity ``` @@ -39,6 +38,9 @@ This example enforces resource security on the local server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPStateServiceDatabase.md index 8f4a35605..afb8244fa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Initialize-SPStateServiceDatabase.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell $db = Get-SPStateServiceDatabase -Identity StateServceDbName Initialize-SPStateServiceDatabase -Identity $db @@ -38,6 +38,9 @@ This example installs the state service database schema into the database associ ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to initialize. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -46,7 +49,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApp.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApp.md index dc59d6bee..58c26be8c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApp.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApp.md @@ -14,7 +14,6 @@ schema: 2.0.0 Installs an instance of an app. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE------------ +### EXAMPLE ```powershell $spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://site_url -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) Install-SPApp -Web https://site_url -Identity $spapp @@ -40,14 +39,16 @@ This example installs an app by first importing the app package, and then instal ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the app to install. The App object is created by using the Import-SPAppPackage cmdlet. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPWeb object of the app. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApplicationContent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApplicationContent.md index 655615104..ee40a56bd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApplicationContent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPApplicationContent.md @@ -14,7 +14,6 @@ schema: 2.0.0 Copies shared application data to existing Web application folders. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Install-SPApplicationContent ``` @@ -40,6 +39,9 @@ This example copies data to a Web application in the existing folders. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,6 +71,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -During a Cummulative Update installation if you face a situation where the full PSConfig cannot run then this cmdlet should be executed on all SharePoint servers to keep the Farm in a supported state. +During a Cummulative Update installation if you face a situation where the full PSConfig cannot run then this cmdlet should be executed on all SharePoint servers to keep the Farm in a supported state. ## RELATED LINKS diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPDataConnectionFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPDataConnectionFile.md index 2175a17ad..708c5dc40 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPDataConnectionFile.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Install-SPDataConnectionFile -Path 'C:\folder\sample.udcx' -Category "Install" -WebAccessible $true ``` @@ -42,6 +42,9 @@ This cmdlet is equivalent to the Upload Data Connection File user interface sett ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the full path to the name of the file in the data connection store. The type must be the name of a valid data connection file; for example, C:\foldername\myconnection.udcx. @@ -49,8 +52,7 @@ The type must be the name of a valid data connection file; for example, C:\folde ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +76,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +86,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Sets an arbitrary category on the file which can be used to group the files. The category name can have a maximum of 255 characters. @@ -90,8 +97,7 @@ The type must be a valid string value; for example, Category1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,14 +126,16 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server Subscription Edition + Overwrites the existing data connection file. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +145,9 @@ Accept wildcard characters: False ``` ### -WebAccessible + +> Applicable: SharePoint Server Subscription Edition + Specifies that the universal data connection file can be accessed by using the Web service. If False, only the Forms Server can retrieve the universal data connection files internally. The default value is False. @@ -142,8 +155,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -160,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPFeature.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPFeature.md index 3a978c889..199070269 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPFeature.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPFeature.md @@ -14,7 +14,6 @@ schema: 2.0.0 Installs a SharePoint Feature by using the Feature.xml file. - ## SYNTAX ### PathSet @@ -51,14 +50,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Install-SPFeature -path "MyCustomFeature" ``` This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Install-SPFeature -AllExistingFeatures -Whatif ``` @@ -66,14 +65,14 @@ Install-SPFeature -AllExistingFeatures -Whatif This example shows the unregistered features that are available on the file system and that are installed if this command is run without the WhatIf parameter. This is commonly done after an upgrade process. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 14 ``` This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature\feature.xml. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Install-SPFeature -path "MyCustomFeature" -CompatibilityLevel 15 ``` @@ -83,6 +82,9 @@ This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies an authentic file path; for example, MyFeature. The path to feature must be a literal path to the 14\Template\Features directory. @@ -93,8 +95,7 @@ If the path to the feature is not found , the following error message is display ```yaml Type: String Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -104,13 +105,15 @@ Accept wildcard characters: False ``` ### -AllExistingFeatures + +> Applicable: SharePoint Server Subscription Edition + Scans for existing, but unregistered features, and then registers them with the farm. ```yaml Type: SwitchParameter Parameter Sets: AllExistingFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -120,14 +123,16 @@ Accept wildcard characters: False ``` ### -ScanForFeatures + +> Applicable: SharePoint Server Subscription Edition + Scans and then displays a feature. The ScanForFeatures parameter does not install a feature. ```yaml Type: SwitchParameter Parameter Sets: ScanForFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -137,6 +142,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -148,8 +156,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,6 +166,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of feature to install. When the version is not specified it will default to the web applications MaxVersion value. @@ -167,8 +177,7 @@ The values for this can be either 14 or 15. ```yaml Type: Int32 Parameter Sets: PathSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,6 +187,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -185,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -195,13 +206,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the installation of an already installed feature. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -211,14 +224,16 @@ Accept wildcard characters: False ``` ### -SolutionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the solution ID of the features. If the SolutionId parameter is not provided, all solution IDs are scanned. ```yaml Type: String Parameter Sets: AllExistingFeatures, ScanForFeatures -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -235,7 +253,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPHelpCollection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPHelpCollection.md index eb3a41e64..bd18cf4f7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPHelpCollection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPHelpCollection.md @@ -14,7 +14,6 @@ schema: 2.0.0 Installs the provided Help site collection files in the current farm. - ## SYNTAX ### InstallAll @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Install-SPHelpCollection -LiteralPath 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1033\OSSAdmin.cab' ``` @@ -51,13 +50,15 @@ This example installs the specified help collection in the current farm. ## PARAMETERS ### -All + +> Applicable: SharePoint Server Subscription Edition + If the LiteralPath parameter is not specified, specifies that all Help Collection CABs under %Program Files%\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\\\ in the Help site collection are installed, and existing Help collections are overwritten. ```yaml Type: SwitchParameter Parameter Sets: InstallAll -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +68,9 @@ Accept wildcard characters: False ``` ### -LiteralPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the exact path to a specific custom Help file in the Help site collection cab file. The type must be a valid path in either of the following forms: @@ -77,8 +81,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: InstallOne -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +105,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPInfoPathFormTemplate.md index 9758f4373..6416234aa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPInfoPathFormTemplate.md @@ -26,15 +26,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES - -### ---------------EXAMPLE 1-------------- +### EXAMPLE 1 ```powershell Install-SPInfoPathFormTemplate -Path c:\Form.xsn ``` This example installs a single form template to the farm. -### ---------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell "FormTemplateFirst.xsn", "FormTemplateSecond.xsn", "FormTemplateThird.xsn" | Install-SPInfoPathFormTemplate ``` @@ -44,6 +43,9 @@ This example installs multiple form templates on a farm. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name of the form template to install. The type must be a valid path and file name of a form template, in the form: @@ -54,8 +56,7 @@ The type must be a valid path and file name of a form template, in the form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -EnableGradualUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new form can be gradually upgraded. - If specified and the form template file exists, the form template is gradually upgraded and is then used for new sessions only. @@ -114,8 +122,7 @@ Specifies that the new form can be gradually upgraded. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -NoWait + +> Applicable: SharePoint Server Subscription Edition + Specifies that the form template is installed in the background and that the progress of the installation not be shown. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +150,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +160,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPService.md index 918af4d21..c6dff88a9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPService.md @@ -14,7 +14,6 @@ schema: 2.0.0 Installs and provisions services on a farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Install-SPService ``` @@ -40,6 +39,9 @@ This example installs all services, service instances and service proxies specif ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +53,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,13 +63,15 @@ Accept wildcard characters: False ``` ### -Provision + +> Applicable: SharePoint Server Subscription Edition + Specifies default settings when installing a standalone service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPSolution.md index 9476744ce..607b0a17a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPSolution.md @@ -14,7 +14,6 @@ schema: 2.0.0 Deploys an installed SharePoint solution in the farm. - ## SYNTAX ### Deploy @@ -43,17 +42,16 @@ Use the Add-SPSolution cmdlet to install a SharePoint solution package in the fa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Install-SPSolution -Identity contoso_solution.wsp -GACDeployment ``` This example deploys the installed SharePoint solution contoso_solution.wsp in the farm and specifies that GAC can be deployed for the new SharePoint solution. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Install-SPSolution -Identity contoso_solution.wsp -GACDeployment -CompatibilityLevel {14,15} ``` @@ -63,15 +61,17 @@ This example deploys the installed SharePoint solution installs a previously add ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint solution to deploy. The value must be an authentic GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an authentic name of a SharePoint solution (for example, SPSolution1); or an instance of an authentic SPSolution object. ```yaml Type: SPSolutionPipeBind -Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: Deploy, Synchronize +Aliases: Required: True Position: 1 @@ -80,27 +80,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSolutionPipeBind -Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server Subscription Edition +### -AllWebApplications -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -AllWebApplications Specifies that the new SharePoint solution is deployed for all SharePoint web applications in the farm. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,13 +123,15 @@ Accept wildcard characters: False ``` ### -CASPolicies + +> Applicable: SharePoint Server Subscription Edition + Specifies that code access security (CAS) policies can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +142,8 @@ Accept wildcard characters: False ### -CompatibilityLevel +> Applicable: SharePoint Server Subscription Edition + Specifies whether to install into the solution, into a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to install the solution only to the version directory based on the version tracked in the manifest of the solution's cab file. Valid values are: @@ -162,8 +157,7 @@ Valid values are: ```yaml Type: String Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,6 +167,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -180,7 +177,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -190,13 +186,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the deployment of the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -206,6 +204,9 @@ Accept wildcard characters: False ``` ### -FullTrustBinDeployment + +> Applicable: SharePoint Server Subscription Edition + Specifies that full trust Bin deployment is permitted. This parameter is to be used if the solution is fully trusted. @@ -216,8 +217,7 @@ For additional information about bin assembly, see Assembly Element ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,13 +227,15 @@ Accept wildcard characters: False ``` ### -GACDeployment + +> Applicable: SharePoint Server Subscription Edition + Specifies that global assembly cache (GAC) can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,6 +245,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies a language for the solution when a solution language package is deployed. If this parameter is not specified, zero ("0") is assumed. Use zero for solutions that are valid for all languages. @@ -250,8 +255,7 @@ Use zero for solutions that are valid for all languages. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -261,13 +265,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Deploys the solution on the active server. ```yaml Type: SwitchParameter Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -277,13 +283,15 @@ Accept wildcard characters: False ``` ### -Synchronize + +> Applicable: SharePoint Server Subscription Edition + Synchronizes all solutions or the specified solution in the local farm. ```yaml Type: SwitchParameter Parameter Sets: Synchronize -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -293,6 +301,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server Subscription Edition + Specifies when the solution will be deployed. The default value is immediate deployment. @@ -301,8 +312,7 @@ The type must be a valid DateTime value, in the form 2010, 5, 1. ```yaml Type: String Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -313,6 +323,8 @@ Accept wildcard characters: False ### -WebApplication +> Applicable: SharePoint Server Subscription Edition + Deploys the SharePoint solution for the specified SharePoint web application. The value must be in one of the following forms: @@ -326,8 +338,7 @@ The value must be in one of the following forms: ```yaml Type: SPWebApplicationPipeBind Parameter Sets: Deploy -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -337,6 +348,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -344,7 +358,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPUserSolution.md index 1ab86dcf8..6c2884b52 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPUserSolution.md @@ -14,7 +14,6 @@ schema: 2.0.0 Activates a sandboxed solution in a site collection. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Install-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` @@ -40,6 +39,9 @@ This example activates the sandboxed solution contoso_solution.wsp in the site h ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution to activate. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -47,8 +49,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Activates the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -65,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPWebPartPack.md b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPWebPartPack.md index 90cce152d..c84010a34 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPWebPartPack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Install-SPWebPartPack.md @@ -49,7 +49,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Install-SPWebPartPack "MyCustomWebPartPack" -LiteralPath "C:\mywebpart.wpp" -GlobalInstall ``` @@ -59,13 +59,15 @@ This example installs the Web Part Package with the name MyCustomWebPartPack glo ## PARAMETERS ### -LiteralPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the exact path to the Web Part package. ```yaml Type: String Parameter Sets: UseFileName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -75,13 +77,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Web Part package to install. ```yaml Type: String Parameter Sets: UseName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -91,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +109,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,13 +138,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Overwrites any existing Web Part package with the same name or installed in the same location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,14 +156,16 @@ Accept wildcard characters: False ``` ### -GlobalInstall + +> Applicable: SharePoint Server Subscription Edition + Installs the Web Part package in the global assembly cache (GAC) rather than in the /bin directory of each Web application. This installation makes the Web Part globally accessible on the servers. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,13 +175,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the language ID for the Web Part package. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,14 +193,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application on which to install the Web Part pack. If no Web application is specified, the Web Part pack is installed on all Web applications. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -196,6 +212,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -203,7 +222,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -213,13 +231,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md index c70809d8b..c2729d337 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/invoke-spprojectactivedirectoryenterpriseresourcepoolsync -Applicable: SharePoint Server Subscription Edition + title: Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync schema: 2.0.0 --- @@ -43,7 +43,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync https://localhost/pwa ``` @@ -53,13 +53,15 @@ This example triggers an Active Directory Enterprise Resource Pool synchronizati ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance where you want to invoke a synchronization. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryGroupSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryGroupSync.md index ad69d6c36..7fd70a974 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryGroupSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Invoke-SPProjectActiveDirectoryGroupSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/invoke-spprojectactivedirectorygroupsync -Applicable: SharePoint Server Subscription Edition + title: Invoke-SPProjectActiveDirectoryGroupSync schema: 2.0.0 --- @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ```powershell Invoke-SPProjectActiveDirectoryGroupSync -Url https://AppServer/pwa ``` @@ -37,6 +37,9 @@ This example synchronizes group membership for the specified PWA instance. ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App (PWA) instance where you want to start the Active Directory sync. The type must be a valid URL, in the form https://\/\. @@ -44,8 +47,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPLogFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPLogFile.md index a8af2f464..d7119aa07 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPLogFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPLogFile.md @@ -14,7 +14,6 @@ schema: 2.0.0 Combines trace log entries from all farm computers into a single log file on the local computer. - ## SYNTAX ``` @@ -35,56 +34,56 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite ``` This example merges the last hour of log data from all farm computers with no filtering. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area Search ``` This example merges the last hour of log data from the Search area. -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area "SharePoint Foundation","Web Analytics Services" ``` This example merges the last hour of log data from the SharePoint Foundation and Web Analytics Services areas. -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Level High ``` This example merges the log data of level High or higher. -### --------------EXAMPLE 5----------------- +### EXAMPLE 5 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -StartTime "06/09/2008 16:00" -EndTime "06/09/2008 16:15" ``` This example merges the log data for events in a particular time range, which is culture-specific to the United States. -### --------------EXAMPLE 6----------------- +### EXAMPLE 6 ```powershell Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Message "*permission changed*" ``` This example merges the log data for events with permission changed in the message text. -### --------------EXAMPLE 7----------------- +### EXAMPLE 7 ```powershell Merge-SPLogFile -Overwrite -Path d:\1.log -ContextFilter "name=timer job*" -Area "*search*" ``` This example merges the log data for all search timer jobs. -### --------------EXAMPLE 8----------------- +### EXAMPLE 8 ```powershell Merge-SPLogFile -Overwrite -Path d:\2.log -ContextFilter "user=contoso?joeuser" ``` @@ -94,14 +93,16 @@ This example shows how to merge the log data for all user names that have a cont ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and file name to which to write the merged log file. Relative paths are supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -111,6 +112,9 @@ Accept wildcard characters: False ``` ### -Area + +> Applicable: SharePoint Server Subscription Edition + Specifies the area name to filter on. The type must be a valid name; for example, SharePoint Foundation. @@ -120,8 +124,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -142,8 +148,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +158,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies the category ID to filter on. The type must be a valid category name; for example, category1. @@ -162,8 +170,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,13 +180,15 @@ Accept wildcard characters: False ``` ### -ContextFilter + +> Applicable: SharePoint Server Subscription Edition + Specifies a filter for trace entries in a particular context in the form key=value, for example, user=contoso\joeuser. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -189,14 +198,16 @@ Accept wildcard characters: False ``` ### -Correlation + +> Applicable: SharePoint Server Subscription Edition + Specifies the correlation ID to filter on. The type must be a valid GUID, in the form F0BB0790-4323-A153-096F-ABCDC80E24D4. ```yaml Type: Guid[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -206,6 +217,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the end time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. @@ -213,8 +227,7 @@ The type must be a valid DateTime format that is culture-specific to the adminis ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -224,14 +237,16 @@ Accept wildcard characters: False ``` ### -EventID + +> Applicable: SharePoint Server Subscription Edition + Specifies the Event ID to filter on. The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -241,6 +256,9 @@ Accept wildcard characters: False ``` ### -ExcludeNestedCorrelation + +> Applicable: SharePoint Server Subscription Edition + Excludes nested correlation values in the results. This parameter is only used when filtering results by using the ContextFilter parameter @@ -250,8 +268,7 @@ Specifying this option includes only the records that match the filter and exclu ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -261,6 +278,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server Subscription Edition + Specifies the level name to filter on. Results include the specified level and everything more severe. @@ -268,8 +288,7 @@ Results include the specified level and everything more severe. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -279,6 +298,9 @@ Accept wildcard characters: False ``` ### -Message + +> Applicable: SharePoint Server Subscription Edition + Specifies the message text to filter on. The type must be valid text. @@ -289,8 +311,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -300,6 +321,9 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server Subscription Edition + Overwrites the log file if it already exists at the specified path. The type must be either of the following values: @@ -312,8 +336,7 @@ The default value is $False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -323,6 +346,9 @@ Accept wildcard characters: False ``` ### -Process + +> Applicable: SharePoint Server Subscription Edition + Specifies the process name to filter on. The use of wildcards is supported. @@ -330,8 +356,7 @@ The use of wildcards is supported. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -341,6 +366,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the start time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US. @@ -350,8 +378,7 @@ The default is one hour prior to the current time on the local computer. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -361,6 +388,9 @@ Accept wildcard characters: False ``` ### -ThreadID + +> Applicable: SharePoint Server Subscription Edition + Specifies the thread ID to filter on. The type must be a valid integer from 0 through 4,294,967,295. @@ -368,8 +398,7 @@ The type must be a valid integer from 0 through 4,294,967,295. ```yaml Type: UInt32[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPUsageLog.md b/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPUsageLog.md index 1e22791ae..733439bd2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPUsageLog.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Merge-SPUsageLog.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/merge-spusagelog -Applicable: SharePoint Server Subscription Edition + title: Merge-SPUsageLog schema: 2.0.0 --- @@ -31,7 +31,7 @@ This cmdlet requires PowerShell Remoting to be enabled. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Merge-SPUsageLog -Identity 'Timer Jobs' -Servers SPSERVER1 ``` @@ -41,6 +41,9 @@ Merges the Usage log for the Usage Definition 'Timer Jobs' from the specified se ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -DiagnosticLogPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the file to write diagnostic information to. A relative path is supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the end time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, that is, 2/16/2007 12:15:12 for English-US. @@ -86,8 +93,7 @@ If you want to specify UTC time, you must add a "Z" to the end of the parameter. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +103,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of usage log file. ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -113,13 +121,15 @@ Accept wildcard characters: False ``` ### -OverWrite + +> Applicable: SharePoint Server Subscription Edition + Overwrites the diagnostic log file if it already exists at the specified path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,13 +139,15 @@ Accept wildcard characters: False ``` ### -Partial + +> Applicable: SharePoint Server Subscription Edition + Not used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +157,9 @@ Accept wildcard characters: False ``` ### -Servers + +> Applicable: SharePoint Server Subscription Edition + The server address or addresses to filter on. To obtain a list of valid addresses in the farm use Get-SPServer | Select Address. @@ -152,8 +167,7 @@ To obtain a list of valid addresses in the farm use Get-SPServer | Select Addres ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +177,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the start time of the log entries returned. The type must be a valid DateTime format that is culture-specific to the administrative language, such as "2/16/2007 12:15:12" for English-US. @@ -174,8 +191,7 @@ If you want to specify UTC time, you must add a "Z" to the end of the parameter. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPDatabase.md index 18adc6c28..b22e19a0b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPDatabase.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/migrate-spdatabase -Applicable: SharePoint Server Subscription Edition + title: Migrate-SPDatabase schema: 2.0.0 --- @@ -34,7 +34,7 @@ Do not use. ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell #Do not use. ``` @@ -44,6 +44,9 @@ Do not use. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +54,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -94,13 +100,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -110,13 +118,15 @@ Accept wildcard characters: False ``` ### -Overwrite + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -126,14 +136,16 @@ Accept wildcard characters: False ``` ### -ServiceType + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: ServiceExtensionType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: DefaultDatabase, Project, UserProfile, SiteSubscription, BDC, Securityobjects, Taxonomy, AppManagement, All -Applicable: SharePoint Server Subscription Edition Required: True Position: 3 @@ -143,13 +155,15 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -159,13 +173,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -175,13 +191,15 @@ Accept wildcard characters: False ``` ### -UseLinkedSqlServer + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 5 @@ -191,6 +209,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -198,7 +219,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPProjectResourcePlans.md b/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPProjectResourcePlans.md index 10b25b19a..caf9b1597 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPProjectResourcePlans.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Migrate-SPProjectResourcePlans.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/migrate-spprojectresourceplans -Applicable: SharePoint Server Subscription Edition + title: Migrate-SPProjectResourcePlans schema: 2.0.0 --- @@ -24,7 +24,7 @@ Migrates the published resource plan assignment data to engagements. Run after d ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Migrate-SPProjectResourcePlans -Url https://pwa_site ``` @@ -33,6 +33,9 @@ Migrates the Project Resource Plans on the Project Web App site https://pwa_site ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -40,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -51,13 +53,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPContentDatabase.md index 85052fb3b..dec09b074 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPContentDatabase.md @@ -15,7 +15,6 @@ Attaches an existing content database to the farm. NOTE: Please be aware that if a content database that does not exists is specified, it will be created by this cmdlet. - ## SYNTAX ``` @@ -40,7 +39,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename ``` @@ -49,7 +48,7 @@ This example mounts an existing database to the sitename web application. If upgrades are required, it triggers database schema upgrade and then performs only build-to-build upgrade actions on existing site collections if required. This operation does not changed the CompatibilityLevel for existing site collections in this database. -### -----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename -NoB2BSiteUpgrade ``` @@ -61,6 +60,9 @@ This operation does not change the CompatibilityLevel for existing site collecti ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing content database to attach to the farm. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -68,8 +70,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Attaches the content database to the specified SharePoint web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -86,8 +90,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,13 +124,15 @@ Accept wildcard characters: False ``` ### -AssignNewDatabaseId + +> Applicable: SharePoint Server Subscription Edition + Creates a new database ID automatically when the content database is attached. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -ChangeSyncKnowledge + +> Applicable: SharePoint Server Subscription Edition + Database attach will cause all Groove sync client to re-synchronize their content. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -168,13 +179,15 @@ Accept wildcard characters: False ``` ### -ClearChangeLog + +> Applicable: SharePoint Server Subscription Edition + Clears any pending changes from the change log in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,6 +197,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Authentication. The type must be a valid PSCredential object. @@ -191,8 +207,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,6 +217,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the content database specified in the Name parameter. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -209,8 +227,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -220,6 +237,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of web sites that can use the content database. The type must be a positive integer. @@ -227,8 +247,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -238,13 +257,15 @@ Accept wildcard characters: False ``` ### -UpdateUserExperience + +> Applicable: SharePoint Server Subscription Edition + Determines whether the content databases should upgrade to the latest user interface. By default, the user interface will not change during upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -253,16 +274,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -NoB2BSiteUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies not to upgrade all child objects when performing a build-to-build upgrade. This parameter has no effect when a version-to-version upgrade is specified. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -272,13 +294,15 @@ Accept wildcard characters: False ``` ### -SkipIntegrityChecks + +> Applicable: SharePoint Server Subscription Edition + Specifies the upgrade process not to run the internal integrity checks such as missing templates, and orphan detection as part of the upgrade process. - + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -288,6 +312,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -295,8 +322,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -306,6 +332,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -313,7 +342,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -323,13 +351,15 @@ Accept wildcard characters: False ``` ### -DatabaseAccessCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the credential that belong to SPDataAccess role. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -339,13 +369,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database server to be mirrored. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -355,13 +387,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to not upgrade all site objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -371,6 +405,9 @@ Accept wildcard characters: False ``` ### -UseLatestSchema + +> Applicable: SharePoint Server Subscription Edition + Specifies to use the latest schema. In an on-premises environment, this parameter has no effect. There are two values $True and $False. @@ -380,8 +417,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPStateServiceDatabase.md index d3a03f6be..9b9aa080c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Mount-SPStateServiceDatabase.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" ``` @@ -39,7 +39,7 @@ This example is used in least privilege scenarios when an administrator cannot c The database must already exist and be empty. The database cannot be used until the Initialize-SPStateServiceDatabase cmdlet is run, so errors could occur with this example. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Mount-SPStateServiceDatabase -Name "statedata1" -DatabaseServer "localhost" -ServiceApplication "ServiceApp1" -Weight 10 | Initialize-SPStateServiceDatabase ``` @@ -50,13 +50,15 @@ The result is immediately piped to the Initialize-SPStateServiceDatabase cmdlet ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the database name that is created in the SQL Server database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +82,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -96,8 +103,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -114,8 +123,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,6 +133,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to which to add the state database. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -132,8 +143,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +153,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server Subscription Edition + Specifies the weight for the state database used to load balance the allocation of new data. The default value is 1. @@ -151,8 +164,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPAppManagementData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPAppManagementData.md index 9f15c1720..4daca4f27 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPAppManagementData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPAppManagementData.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/move-spappmanagementdata -Applicable: SharePoint Server Subscription Edition + title: Move-SPAppManagementData schema: 2.0.0 --- @@ -25,15 +25,17 @@ Do Not Use ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell Do Not Use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -OverWrite + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,12 +89,14 @@ Accept wildcard characters: False ``` ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,12 +106,14 @@ Accept wildcard characters: False ``` ### -SourceAppManagementDatabase + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -114,13 +123,15 @@ Accept wildcard characters: False ``` ### -TargetContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -130,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -137,7 +151,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPBlobStorageLocation.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPBlobStorageLocation.md index 770761cf3..12bfb872a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPBlobStorageLocation.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPBlobStorageLocation.md @@ -14,7 +14,6 @@ schema: 2.0.0 Copies a content database to a new location by using Remote BLOB Storage (RBS). - ## SYNTAX ``` @@ -34,14 +33,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Move-SPBlobStorageLocation WSS_Content ``` This example copies the content database named WSS_Content from the Windows Internal Database to the same database name in SQL Server 2008 Express by using RBS. -### -------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Move-SPBlobStorageLocation WSS_Content -DestinationDatabase WSS_V4_Content -BackupDatabase WSSBackupDB -VerboseMod:$true ``` @@ -54,13 +53,15 @@ The output of this command displays log information to the Command Prompt window ## PARAMETERS ### -SourceDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Windows Internal Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +85,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +105,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -109,14 +114,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the migrated database. If the DestinationDatabase parameter is not specified, the SourceDatabase parameter is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -DestinationDataSourceInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the instance of the destination database. The value in the SourceDatabase parameter is migrated to this instance. The name of the instance of the database should be SQL Server with Service Pack 1 (SP1) and Cumulative Update 2 version or higher. @@ -134,8 +144,7 @@ If the DestinationDataSourceInstance parameter is not specified, the local host ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +154,9 @@ Accept wildcard characters: False ``` ### -Dir + +> Applicable: SharePoint Server Subscription Edition + Used for all disk operations, including storing temporary backups and database (.mdf) files of a migrated database. If the Dir parameter is not specified, a default directory of the destination SQL Server instance is used. The free space in this directory should be at least two times the size of the source database. @@ -152,8 +164,7 @@ The free space in this directory should be at least two times the size of the so ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,14 +174,16 @@ Accept wildcard characters: False ``` ### -VerboseMod + +> Applicable: SharePoint Server Subscription Edition + Generates verbose log output to be displayed in the Command Prompt window. If the VerboseMod parameter is not specified, no output is displayed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +203,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPCertificate.md index 88577f0e4..27bda32c8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPCertificate.md @@ -24,7 +24,7 @@ Moves the specified certificate to a different certificate store. ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Move-SPCertificate -Identity "Team Site Certificate" -NewStore EndEntity ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPDeletedSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPDeletedSite.md index f6159bf34..7c92c9832 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPDeletedSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPDeletedSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Moves deleted site collections from one content database to another. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------EXAMPLE---------- +### EXAMPLE ```powershell Move-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c -DestinationDatabase "ContentDB2" ``` @@ -40,14 +39,16 @@ This example moves deleted site collections from the specified GUID to the datab ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the site collection to be moved. For example, https://servername/sites/sitename. ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,14 +58,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database that the site collection should be moved to. For example, ContentDB2. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,14 +120,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +139,9 @@ Accept wildcard characters: False ``` ### -RbsProviderMapping + +> Applicable: SharePoint Server Subscription Edition + Used to move a Remote BLOB Storage (RBS)-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying Binary Large Object (BLOB) content. If the content database has more than one RBS provider associated with it, you must specify all providers. The same providers must be enabled on the target content database and the source content database. @@ -137,8 +149,7 @@ The same providers must be enabled on the target content database and the source ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -155,8 +169,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +189,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPEnterpriseSearchLinksDatabases.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPEnterpriseSearchLinksDatabases.md index d24e53153..582293fc9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPEnterpriseSearchLinksDatabases.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPEnterpriseSearchLinksDatabases.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceapplication $ssa | New-SPEnterpriseSearchLinksDatabase -DatabaseName "links1" @@ -48,6 +48,8 @@ This example adds 3 new links databases and uses Move-SPEnterpriseSearchLinksDat ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -55,12 +57,10 @@ Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -71,6 +71,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,12 +82,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,16 +96,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,15 +116,15 @@ Accept wildcard characters: False ### -RepartitioningId -Resumes the move with this identifier. +> Applicable: SharePoint Server Subscription Edition +Resumes the move with this identifier. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,16 +135,16 @@ Accept wildcard characters: False ### -SourceStores +> Applicable: SharePoint Server Subscription Edition + Specifies a source list of databases. If this parameter is not specified then all currently existing links databases will be used as a source list. - ```yaml Type: LinksStore[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,16 +155,16 @@ Accept wildcard characters: False ### -TargetStores +> Applicable: SharePoint Server Subscription Edition + Specifies a target list of databases. If this parameter is not specified then all currently existing links databases will be used as a target list. - ```yaml Type: LinksStore[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,16 +175,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPProfileManagedMetadataProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPProfileManagedMetadataProperty.md index e5f59a145..31bbd91f7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPProfileManagedMetadataProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPProfileManagedMetadataProperty.md @@ -32,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------------ +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Move-SPProfileManagedMetadataProperty -ProfileServiceApplicationProxy $proxy -Identity SPS-Interests -TermSetName Interests -AvailableForTagging @@ -43,13 +43,15 @@ This example moves values from the SPS-Interests property into a new term set ca ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the profile property that needs to be migrated to the taxonomy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +93,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -AvailableForTagging + +> Applicable: SharePoint Server Subscription Edition + Determines whether the terms in the resulting term set can be used for Managed Metadata tagging. If a term set has more than 30,000 terms, using it for Managed Metadata tagging may lead to performance issues on the client computer. Because a majority of the profile properties may have more than 30,000 terms, the default value is No. @@ -104,8 +113,7 @@ Because a majority of the profile properties may have more than 30,000 terms, th ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -132,14 +142,16 @@ Accept wildcard characters: False ``` ### -TermSetName + +> Applicable: SharePoint Server Subscription Edition + When specified, the term set name is created. If the TermSetName parameter is not specified, the property is mapped to the Keywords term set in Managed Metadata Service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSite.md index 64ba88f0b..15c341a06 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSite.md @@ -14,7 +14,6 @@ schema: 2.0.0 Moves site collections from one content database to another. - ## SYNTAX ``` @@ -29,7 +28,7 @@ The Move-SPSite cmdlet moves the data in the specified site collection from its A no-access lock is applied to the site collection to prevent users from altering data within the site collection while the move is taking place. -Once the move is complete, the site collection is returned to its original lock state. +Once the move is complete, the site collection is returned to its original lock state. An IIS reset is required on any server running the Microsoft SharePoint Foundation Web Application service for the site move to take effect. This is not required for SharePoint Server 2019. @@ -38,24 +37,23 @@ The destination content database specified must already exist, must be attached For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Move-SPSite https://servername/sites/sitename -DestinationDatabase ContentDb2 ``` This example moves the site collection https://servername/sites/sitename to the content database ContentDb2. -### ---------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPSite -ContentDatabase ContentDb1 | Move-SPSite -DestinationDatabase ContentDb2 ``` This example moves all site collections in ContentDb1 to ContentDb2. -### ---------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell Get-SPSiteAdministration | where { $_.OwnerLoginName -eq "DOMAIN\username" } | Move-SPSite -DestinationDatabase ContentDb2 ``` @@ -64,7 +62,7 @@ This example moves all site collections where DOMAIN\username is the site collec The Get-SPSiteAdministration cmdlet is used instead of the Get-SPSite cmdlet because you must have permission within the site collection to access the properties of the SPSite object. You can access the properties of the SPSiteAdministration object as a SharePoint farm administrator. -### ---------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ```powershell Move-SPSite -Identity siteUrl -DestinationDatabase databaseName -RbsProviderMapping @{"sourceProvider1"="targetProvider1", "sourceProvider2"="targetProvider2"} @@ -75,14 +73,16 @@ This example moves an RBS-enabled site collection from one RBS-enabled content d ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the site collection to be moved. For example, https://servername/sites/sitename. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -92,14 +92,16 @@ Accept wildcard characters: False ``` ### -DestinationDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database that the site collection should be moved to. For example, ContentDB2. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +125,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +145,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,6 +154,9 @@ Accept wildcard characters: False ``` ### -RbsProviderMapping + +> Applicable: SharePoint Server Subscription Edition + This parameter was added in SharePoint Server with Service Pack 1 (SP1) and SharePoint Foundation with Service Pack 1 (SP1). Used to move an RBS-enabled site collection from one RBS-enabled content database to another RBS-enabled content database without moving the underlying BLOB content. @@ -157,8 +166,7 @@ The same providers must be enabled on the target content database and the source ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,6 +176,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -175,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -185,6 +195,9 @@ Accept wildcard characters: False ``` ### -CopyEvents + +> Applicable: SharePoint Server Subscription Edition + Specifies if events of the EventCache table need to be copied to the destination Content Database. The valid values are True or False. @@ -192,8 +205,7 @@ The valid values are True or False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSocialComment.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSocialComment.md index 96a0b0277..49d473d27 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSocialComment.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPSocialComment.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------Example 1 ----------- +### Example 1 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Move-SPSocialComments -ProfileServiceApplicationProxy $proxy -OldUrl "https://contoso/Pages/oldtest.aspx" -NewUrl "https://contoso/Pages/newtest.aspx" @@ -42,6 +42,9 @@ This example moves social comments from oldtest.aspx to newtest.aspx. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -49,8 +52,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -60,13 +62,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -76,13 +80,15 @@ Accept wildcard characters: False ``` ### -NewUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the target URI to which the social notes will be moved. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,13 +98,15 @@ Accept wildcard characters: False ``` ### -OldUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the source URI from which the social notes will be moved. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,13 +116,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -124,6 +134,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. @@ -131,8 +144,7 @@ This parameter is mandatory in a hosted-environment and optional in a non-hosted ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -149,7 +164,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPUser.md b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPUser.md index 16a2ab1f8..4232ffc55 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPUser.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Move-SPUser.md @@ -14,7 +14,6 @@ schema: 2.0.0 Migrates a user account in SharePoint Products. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $user = Get-SPUser -Identity "DOMAIN\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "Domain\JaneSmith" -IgnoreSid @@ -38,7 +37,7 @@ Move-SPUser -Identity $user -NewAlias "Domain\JaneSmith" -IgnoreSid This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $user = Get-SPUser -Identity "DomainA\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "DomainB\JaneDoe" @@ -46,7 +45,7 @@ Move-SPUser -Identity $user -NewAlias "DomainB\JaneDoe" This example migrates DOMAIN\JaneDoe from DomainA to the new account of DOMAINB\JaneDoe in DomainB with SID History enabled. -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell $user = Get-SPUser -Identity "i:0#.w|DOMAIN\JaneDoe" -Web https://webUrl Move-SPUser -Identity $user -NewAlias "i:0#.w|Domain\JaneSmith" -IgnoreSid @@ -57,6 +56,9 @@ This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith when ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the `SPUser` object retrieved via `Get-SPUser`. The type must be a valid `SPUser` object. @@ -65,7 +67,6 @@ The type must be a valid `SPUser` object. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -NewAlias + +> Applicable: SharePoint Server Subscription Edition + Specifies the new login name of the user account. The type must be a valid login name, in the form DOMAIN\username. @@ -82,8 +86,7 @@ The type must be a valid login name, in the form DOMAIN\username. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -IgnoreSID + +> Applicable: SharePoint Server Subscription Edition + Indicates (if present) that Active Directory will not be queried for the SID history attribute to ensure that the new login name is correspondent to the old login name. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAlternateURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAlternateURL.md index a1b51d595..beb9c2858 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAlternateURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAlternateURL.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new public or internal URL for the specified Web application zone or resource. - ## SYNTAX ### WebApplication @@ -51,7 +50,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell #create the public URL New-SPAlternateURL https://www.contoso.com -Zone "Internet" @@ -67,6 +66,9 @@ When a reverse proxy is being set up to handle public URL SSL termination, alter ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the public URL that users access to sign in to the Web application. The type must be a valid URL, in the form https://server_name. @@ -74,8 +76,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application for which to create the mapping. The type must be a valid name, URL, in the form WebApplication-1212, https://server_name, or GUID, in the form 1234-5678-9876-0987. @@ -92,8 +96,7 @@ The type must be a valid name, URL, in the form WebApplication-1212, https://ser ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -ResourceName + +> Applicable: SharePoint Server Subscription Edition + Specifies the resource name, if the alternate URL is for an external resource. If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: ResourceName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,8 +139,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -159,14 +168,16 @@ Accept wildcard characters: False ``` ### -Internal + +> Applicable: SharePoint Server Subscription Edition + Makes this alternate URL an internal URL. If this parameter is not provided, the URL is a public URL. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,6 +187,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the five zones with which the alternate URL is associated. The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom. @@ -200,8 +216,7 @@ The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom. ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplication.md index c0d5c5c91..70cd82190 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates an App Management Service application. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE---------- +### EXAMPLE ```powershell New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool ``` @@ -42,13 +41,15 @@ The new service application will run under the app pool named MyServiceAppPool ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the application pool of the service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use when creating the service application database. These credentials will have owner rights on the newly created service application database. If a value is not provided, the current user's credentials are used by default. @@ -104,8 +112,7 @@ If a value is not provided, the current user's credentials are used by default. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,14 +122,16 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application database to be created. If a value is not provided, a default database name is provided. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server of the service application database to be created, If a value is not provided, the default database server is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,13 +159,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the failover server of the service application database to be created, If a value is not provided, there will not be a failover server for the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,14 +177,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application to be created. If not provided, the default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -181,6 +196,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -188,7 +206,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -198,13 +215,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplicationProxy.md index 6b501ce3e..98802b37a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAppManagementServiceApplicationProxy.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates an App Management Service application proxy. - ## SYNTAX ### ServiceApplication @@ -42,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ```powershell $sa = New-SPAppManagementServiceApplication -Name AppManagement -DatabaseServer MyDatabaseServer -DatabaseName AppManagementDB -ApplicationPool MyServiceAppPool New-SPAppManagementServiceApplicationProxy -Name AppManagementProxy -UseDefaultProxyGroup -ServiceApplication $sa @@ -53,13 +52,15 @@ This example creates a new App Management Service application proxy named AppMan ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the App Management Service application for which you are creating the service application proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -69,13 +70,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the endpoint URI of the App Management Service application in which to create the service application proxy. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +102,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,14 +131,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application proxy to be created. If a value is not provided, a default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,13 +150,15 @@ Accept wildcard characters: False ``` ### -UseDefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to add the newly created service application proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +168,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -164,7 +178,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAuthenticationProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAuthenticationProvider.md index ffbd571b7..86bf1ff55 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAuthenticationProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAuthenticationProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new authentication provider in the farm. - ## SYNTAX ### Forms @@ -52,7 +51,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------------------EXAMPLE1------------------ +### ---------------------------EXAMPLE1------------------ ```powershell $ap = New-SPAuthenticationProvider -UseWindowsIntegratedAuthentication Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -60,7 +59,7 @@ Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App This example creates a Windows claims authentication provider. -### ---------------------------EXAMPLE2------------------ +### ---------------------------EXAMPLE2------------------ ```powershell $ap = New-SPAuthenticationProvider -ASPNETMembershipProvider "membership" -ASPNETRoleProviderName "rolemanager" Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -68,7 +67,7 @@ Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App This example creates an authentication provider that is based on the ASP.NET membership role provider. -### ---------------------------EXAMPLE3------------------ +### ---------------------------EXAMPLE3------------------ ```powershell $ap = New-SPAuthenticationProvider -TrustedIdentityTokenIssuer | Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http:// -Port 80 -AuthenticationProvider $ap @@ -79,6 +78,9 @@ This example creates a trusted token issuer authentication provider. ## PARAMETERS ### -ASPNETMembershipProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the membership provider. The value must be a valid name of an ASP.NET membership provider; for example, myMembershipProvider. @@ -86,8 +88,7 @@ The value must be a valid name of an ASP.NET membership provider; for example, m ```yaml Type: String Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +98,9 @@ Accept wildcard characters: False ``` ### -ASPNETRoleProviderName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the role provider. The value must be a valid name of an ASP.NET role provider; for example, myRoleProvider. @@ -104,8 +108,7 @@ The value must be a valid name of an ASP.NET role provider; for example, myRoleP ```yaml Type: String Parameter Sets: Forms -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the authentication provider. The value must be in one of the following forms: @@ -126,8 +132,7 @@ The value must be in one of the following forms: ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: Trusted -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -137,13 +142,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymous + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the web application allows anonymous access. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -164,8 +174,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,13 +184,15 @@ Accept wildcard characters: False ``` ### -DisableKerberos + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the web application disables Kerberos authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,13 +202,15 @@ Accept wildcard characters: False ``` ### -UseBasicAuthentication + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the web application uses Basic authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -207,13 +220,15 @@ Accept wildcard characters: False ``` ### -UseWindowsIntegratedAuthentication + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the web application uses Integrated Windows authentication. ```yaml Type: SwitchParameter Parameter Sets: Windows -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAzureAccessControlServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAzureAccessControlServiceApplicationProxy.md index f700650ab..68f93d089 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAzureAccessControlServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPAzureAccessControlServiceApplicationProxy.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new service application proxy group. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------- +### EXAMPLE ```powershell New-SPAzureAccessControlServiceApplicationProxy -Name "ACS" -metadataEndpointUri "http://test" -DefaultProxyGroup ``` @@ -40,13 +39,15 @@ This example creates a proxy group named ACS which will be added to the default ## PARAMETERS ### -MetadataServiceEndpointUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Azure Access Control Service's metadata document. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +57,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the proxy that you want to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +89,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the proxy needs to be added to the default proxy group. We recommend that you add the proxy to the default proxy group. @@ -118,8 +128,7 @@ We recommend that you add the proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBECWebServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBECWebServiceApplicationProxy.md index 4d3364b78..b6e099dbb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBECWebServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBECWebServiceApplicationProxy.md @@ -34,13 +34,15 @@ For permissions and the most current information about Windows PowerShell for Sh ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -50,13 +52,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -66,13 +70,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,13 +88,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -98,13 +106,15 @@ Accept wildcard characters: False ``` ### -ServiceEndpointUri + +> Applicable: SharePoint Server Subscription Edition + Do not use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -114,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -121,7 +134,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplication.md index e89c79f10..08a707ee1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplication.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new Business Data Connectivity service application in the farm. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" ``` @@ -43,13 +42,15 @@ In this process it uses the SharePoint Web Services Default application pool and ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS application pool to use for the new Business Data Connectivity service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name for the Business Data Connectivity database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SERVER\Database. @@ -82,8 +88,7 @@ The type must be a valid SQL Server host name; for example, SERVER\Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a display name for the new Business Data Connectivity service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +130,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -155,8 +169,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +179,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -174,8 +190,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,14 +200,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,13 +219,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -218,6 +237,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. @@ -226,8 +248,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -237,13 +258,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Business Data Connectivity application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -253,6 +276,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -260,7 +286,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -270,13 +295,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplicationProxy.md index 0c6e8f2d6..23ce2ee05 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPBusinessDataCatalogServiceApplicationProxy.md @@ -40,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $sa = New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp" New-SPBusinessDataCatalogServiceApplicationProxy -Name "ContosoServiceAppProxy" -ServiceApplication $sa @@ -51,13 +51,15 @@ This example creates a new Business Data Connectivity service application proxy ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a display name for the new Business Data Connectivity service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,6 +87,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of a remote service application to which to connect. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -90,8 +97,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,6 +107,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +121,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,6 +131,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +141,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -140,13 +150,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application proxy is added to the default proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,6 +168,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +178,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -173,6 +187,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies if partition mode is to be turned on. The valid values are True and False. The default value is False. @@ -180,8 +197,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCache.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCache.md index e358ba9ef..e38a21115 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCache.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCache.md @@ -24,7 +24,7 @@ Use the New-SPCache cmdlet to create a new named cache. ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell New-SPCache -CacheName DistributedViewStateCache_b6c5efa9-e390-4d47-aa8a-45232229992b ``` @@ -34,6 +34,9 @@ This example creates a new cache named 'DistributedViewStateCache_b6c5efa9-e390- ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -CacheName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new cache. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -95,7 +104,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCentralAdministration.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCentralAdministration.md index b546baa9c..7aa52edfa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCentralAdministration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPCentralAdministration.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new SharePoint Central Administration Web application. - ## SYNTAX ### SetIisWebSiteBinding @@ -38,15 +37,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPCentralAdministration -WindowsAuthProvider NTLM -Port 8080 ``` This example creates the Central Administration site at port 8080 on the local farm using NTLM authentication. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell New-SPCentralAdministration -WindowsAuthProvider Kerberos -Port 443 -SecureSocketsLayer -HostHeader centraladmin.example.com ``` @@ -56,6 +54,9 @@ This example creates the Central Administration site using SSL on port 443 with ## PARAMETERS ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -68,7 +69,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the certificate that will be used for the Secure Sockets Layer (SSL) binding of this IIS website. This parameter is only valid when used with the SecureSocketsLayer parameter. @@ -107,7 +112,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SPServerCertificatePipeBind Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -117,6 +121,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies the host header of the Central Administration IIS website. If this parameter is omitted there will be no host header binding and the URL of the Central Administration site will be based on the name of this server. @@ -125,7 +132,6 @@ If this parameter is omitted there will be no host header binding and the URL of Type: String Parameter Sets: SetIisWebSiteBinding Aliases: Host -Applicable: SharePoint Server Subscription Edition Required: False Position: 4 @@ -135,6 +141,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: SharePoint Server Subscription Edition + Specifies the port number for Central Administration. If no port is specified, a nonconflicting port number is auto-generated. @@ -146,7 +155,6 @@ If you specify a port number that has already been assigned, IIS does not start Type: Int32 Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -156,6 +164,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Enables Secure Sockets Layer (SSL) encryption for the Central Administration IIS website. If you choose to use SSL, you must import a server certificate to SharePoint and assign it to the Central Administration IIS website. The Central Administration web application won't be accessible until you do this. @@ -168,7 +179,6 @@ If this parameter is omitted or set to False the Central Administration site wil Type: SwitchParameter Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: 3 @@ -178,13 +188,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the load-balanced URL for Central Administration. ```yaml Type: String Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -194,6 +206,9 @@ Accept wildcard characters: False ``` ### -UseServerNameIndication + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Sockets Layer (SSL) binding of this IIS website should use Server Name Indication (SNI). Server Name Indication allows multiple IIS websites with unique host headers and unique server certificates to share the same SSL port. If Server Name Indication isn't used, all IIS websites sharing the same SSL port must share the same server certificate. @@ -202,7 +217,6 @@ If Server Name Indication isn't used, all IIS websites sharing the same SSL port Type: SwitchParameter Parameter Sets: SetIisWebSiteBinding Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -212,6 +226,9 @@ Accept wildcard characters: False ``` ### -WindowsAuthProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication provider for this web application. If no authentication provider is specified, the default value NTLM is used. @@ -221,7 +238,6 @@ The type must be one of two values: Kerberos or NTLM. Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: 2 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimProvider.md index b48c4fb3c..523606f1a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimProvider.md @@ -14,7 +14,6 @@ schema: 2.0.0 Registers a new claim provider in the farm. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell New-SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -Default ``` @@ -39,6 +38,9 @@ This example registers a claim provider to all Web applications and zones. ## PARAMETERS ### -AssemblyName + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid name of an assembly; for example, ClaimAssembly1. Specifies the name of the assembly with the claim provider. @@ -46,8 +48,7 @@ Specifies the name of the assembly with the claim provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description of the claim provider. The type must be a valid name of an assembly; for example, ClaimAssembly1. @@ -64,8 +68,7 @@ The type must be a valid name of an assembly; for example, ClaimAssembly1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the new claim provider. The type must be a valid name of a claim provider; for example, ClaimProvider1. @@ -82,8 +88,7 @@ The type must be a valid name of a claim provider; for example, ClaimProvider1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of the claim. The type must be a valid name of a claim type; for example MyClaimProvider.Providers.CustomProvider. @@ -100,8 +108,7 @@ The type must be a valid name of a claim type; for example MyClaimProvider.Provi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -111,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -122,8 +132,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + Specifies that the claim provider applies to all Web applications and zones. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: SharePoint Server Subscription Edition + Turns on the claim provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeEncoding.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeEncoding.md index 2fbc051de..613ddaa7e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeEncoding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeEncoding.md @@ -14,7 +14,6 @@ schema: 2.0.0 Registers a new type of claim. - ## SYNTAX ``` @@ -38,10 +37,9 @@ For more information about the SPClaim methods and properties, see M:Microsoft.S For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE------- +### EXAMPLE ```powershell New-SPClaimTypeEncoding -EncodingCharacter '1' -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country" ``` @@ -51,13 +49,15 @@ This example registers a new type of claim. ## PARAMETERS ### -ClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of claim for which you want to create a mapping. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,13 +67,15 @@ Accept wildcard characters: False ``` ### -EncodingCharacter + +> Applicable: SharePoint Server Subscription Edition + Specifies the Unicode character to which you want to create a mapping. ```yaml Type: Char Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +99,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -105,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,13 +128,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Suppresses confirmation messages to any claim type that is added. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeMapping.md index 97664e452..8fb1de9d3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimTypeMapping.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1---------------------------- +### EXAMPLE 1 ```powershell $map1 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming $map2 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" @@ -40,6 +40,9 @@ This example creates a claim map from an incoming token to a SharePoint token. ## PARAMETERS ### -IncomingClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the incoming claim type. The type must be a valid URI, in the form http://schemas.microsoft.com/email. @@ -47,8 +50,7 @@ The type must be a valid URI, in the form http://schemas.microsoft.com/email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -IncomingClaimTypeDisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the incoming claim type. The type must be a valid name of an incoming claim type; for example, Email. @@ -65,8 +70,7 @@ The type must be a valid name of an incoming claim type; for example, Email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -LocalClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the local claim type. If the SameAsIncoming parameter is False, this is a required parameter. @@ -84,8 +91,7 @@ The type must be a valid URI, in the form http://schemas.microsoft.com/email. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +115,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,13 +125,15 @@ Accept wildcard characters: False ``` ### -SameAsIncoming + +> Applicable: SharePoint Server Subscription Edition + Specifies that the claim type specified in the IncomingClaimType parameter is used for the LocalClaimType parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimsPrincipal.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimsPrincipal.md index a3e3569d2..efbfab7ca 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimsPrincipal.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPClaimsPrincipal.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a claims principal. - ## SYNTAX ### STSIdentity @@ -59,28 +58,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal contoso\johndoe -TrustedIdentityTokenIssuer "NTLM") ``` This example creates a claim principal for a Windows user. -### -------------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell New-SPSite https://localhost/sites/newsite -owner (New-SPClaimsPrincipal contoso\allusers -TrustedIdentityTokenIssuer "NTLM") ``` This example creates a claim principal for a Windows group. -### -------------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal -ClaimValue "john@contoso.com" -ClaimType Email -TrustedIdentityTokenIssuer "LiveID STS" -IdentifierClaim Yes) ``` This example creates a claim principal for a trusted identity token issuer claim. -### -------------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell $ip = New-SPIdentityProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider" New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@contoso.com" -TrustedIdentityTokenIssuer $ip) @@ -88,14 +87,14 @@ New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@co This example creates a claim principal for a ASPNet Membership User. -### -------------------------EXAMPLE 5----------------------------- +### EXAMPLE 5 ```powershell New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "Sales Manager Role" -IdentityProvider "myRoleProvider") ``` This example creates a claim principal for a ASPNet Role. -### -------------------------EXAMPLE 6----------------------------- +### EXAMPLE 6 ```powershell $cp = New-SPClaimsPrincipal -Identity "redmond\SiteOwner" -IdentityType 1 New-SPSite https://servername:port -OwnerAlias $cp.ToEncodedString() -Template "STS#0" @@ -106,6 +105,9 @@ This example creates a claim principal for a Basic Claim Role, which is also cal ## PARAMETERS ### -ClaimValue + +> Applicable: SharePoint Server Subscription Edition + Specifies the claim value of the claims object. The claims value specifies the user, group, or computer that the claim is authenticating. @@ -114,8 +116,7 @@ The type must be a valid claim value; for example, john@contoso.com. ```yaml Type: String Parameter Sets: STSIdentity, ClaimProvider -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -125,6 +126,9 @@ Accept wildcard characters: False ``` ### -EncodedClaim + +> Applicable: SharePoint Server Subscription Edition + Converts a simple claim to a full encoded claim. The type must be a valid claim value; for example, i:001w|redmond\user. @@ -132,8 +136,7 @@ The type must be a valid claim value; for example, i:001w|redmond\user. ```yaml Type: String Parameter Sets: BasicClaim -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -143,6 +146,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new claims principal. The type must be a valid name of a claims principal. @@ -150,8 +156,7 @@ The type must be a valid name of a claims principal. ```yaml Type: String Parameter Sets: IdentityType, TrustIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -161,6 +166,9 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of claim to create. The value I indicates a unique user identity claim, and the value C indicates all other claims. @@ -168,9 +176,8 @@ The type must be either of the following values: I or C. ```yaml Type: String -Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: STSIdentity, ClaimProvider +Aliases: Required: False Position: 2 @@ -179,20 +186,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server Subscription Edition +### -TrustedIdentityTokenIssuer -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -TrustedIdentityTokenIssuer Specifies the ID of the authentication provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an Authentication provider (for example, MyAuthprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object. @@ -200,8 +197,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: STSIdentity, TrustIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -211,6 +207,9 @@ Accept wildcard characters: False ``` ### -IdentityType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of the new claims principal. The type must be one of the following: WindowsSamAccountName, WindowsSecurityGroupSid, FormsUser, FormsRole, or EncodedClaim. @@ -218,8 +217,7 @@ The type must be one of the following: WindowsSamAccountName, WindowsSecurityGro ```yaml Type: SPIdentifierTypes Parameter Sets: IdentityType -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -229,13 +227,15 @@ Accept wildcard characters: False ``` ### -IdentifierClaim + +> Applicable: SharePoint Server Subscription Edition + Specifies if the new claim is an identity claim. ```yaml Type: SwitchParameter Parameter Sets: STSIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -245,6 +245,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -256,8 +259,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -267,6 +269,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the security token service identity provider that will contain the claims principal. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. @@ -274,8 +279,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProvider Parameter Sets: ClaimProvider -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPConfigurationDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPConfigurationDatabase.md index 38e27522f..a8666cc16 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPConfigurationDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new configuration database. - ## SYNTAX ``` @@ -35,21 +34,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) ``` This example prompts the user to provide user credentials for the default Farm Administrator account. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -SkipRegisterAsDistributedCacheHost ``` This example prompts the user to provide user credentials for the default Farm Administrator account and skips registering the server as Distributed Cache host. Applies to SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 only. -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -LocalServerRole Custom ``` @@ -59,13 +58,15 @@ This example prompts the user to provide user credentials for the default Farm A ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new configuration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -75,14 +76,16 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server on which to create the configuration database. If no value is specified, the default value is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -92,14 +95,16 @@ Accept wildcard characters: False ``` ### -DirectoryDomain + +> Applicable: SharePoint Server Subscription Edition + Specifies the directory domain for the new farm. If no domain is specified, the domain in which the local computer is located is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -109,14 +114,16 @@ Accept wildcard characters: False ``` ### -DirectoryOrganizationUnit + +> Applicable: SharePoint Server Subscription Edition + Specifies the directory organizational unit for the new configuration database. If no organizational unit is specified, the organizational unit in which the local computer is located is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -126,14 +133,16 @@ Accept wildcard characters: False ``` ### -AdministrationContentDatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name for the Central Administration content database for the new farm. If no name is specified, a default name is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 5 @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the Credential object for the database user. Use this parameter if you use SQL Server Authentication. If no database credentials are provided, Windows authentication is used. @@ -150,8 +162,7 @@ If no database credentials are provided, Windows authentication is used. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 6 @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -FarmCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies credentials for the Farm Administrator account. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 7 @@ -177,14 +190,16 @@ Accept wildcard characters: False ``` ### -Passphrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the secure password phrase for the new farm. This passphrase is used to join other machines to this farm. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 8 @@ -194,6 +209,9 @@ Accept wildcard characters: False ``` ### -SkipRegisterAsDistributedCacheHost + +> Applicable: SharePoint Server Subscription Edition + By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default). Use this parameter to not register the server computer as a distributed cache host. @@ -202,8 +220,7 @@ If you want to have a dedicated cache host, then use this parameter to make sure ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 9 @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -224,8 +244,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -235,13 +254,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailOverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server Database Mirror partner server for the Configuration and Central Administration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -251,6 +272,9 @@ Accept wildcard characters: False ``` ### -LocalServerRole + +> Applicable: SharePoint Server Subscription Edition + Specifies the Server Role. Valid options for all versions of SharePoint Server 2016, SharePoint Server 2019 are: `Custom`, `SingleServerFarm`, `Application`, `WebFrontEnd`, `DistributedCache`, `Search` @@ -260,8 +284,7 @@ With the addition of Feature Pack 1, new options include: ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -271,13 +294,15 @@ Accept wildcard characters: False ``` ### -ServerRoleOptional + +> Applicable: SharePoint Server Subscription Edition + Configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -287,13 +312,15 @@ Accept wildcard characters: False ``` ### -SiteMapDatabaseName + +> Applicable: SharePoint Server Subscription Edition + Do not use. Specifies the database name of the Site Map site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -303,13 +330,15 @@ Accept wildcard characters: False ``` ### -SiteMapDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Do not use. Specifies the database server name of the Site Map site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -319,6 +348,9 @@ Accept wildcard characters: False ``` ### -DatabaseConnectionEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies whether TLS encryption is used for the connection between SharePoint and the database. Mandatory requires that TLS encryption is used. If TLS encryption can't be successfully negotiated, the connection will fail. Optional allows TLS encryption to be used. If the database server requires TLS encryption, then TLS encryption will be used. Otherwise, TLS encryption will not be used. @@ -329,7 +361,7 @@ Databases mounted to SharePoint before the Version 24H2 feature update was insta Type: SqlConnectionEncryptOption Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: Mandatory @@ -338,13 +370,16 @@ Accept wildcard characters: False ``` ### -DatabaseServerCertificateHostName + +> Applicable: SharePoint Server Subscription Edition + Sets the host name to use when validating the server certificate for the connection. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDatabase.md index 5413dce9c..19883af66 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDatabase.md @@ -14,7 +14,6 @@ schema: 2.0.0 Creates a new content database and attaches it to the specified Web application. - ## SYNTAX ``` @@ -32,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE-------------------- +### EXAMPLE ```powershell New-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication https://sitename ``` @@ -42,6 +41,9 @@ This example creates a new content database for the sitename Web application. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new content database to create within the farm. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -49,8 +51,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Attaches the content database to the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -67,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -89,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -AssignNewDatabaseId + +> Applicable: SharePoint Server Subscription Edition + Creates a new database ID automatically when the content database is attached. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,13 +142,15 @@ Accept wildcard characters: False ``` ### -ClearChangeLog + +> Applicable: SharePoint Server Subscription Edition + Clears any pending changes from the change log in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +160,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -156,8 +170,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,6 +180,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the content database specified in the Name parameter. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -174,8 +190,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of Web sites that can use the content database. The type must be a positive integer. @@ -192,8 +210,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -203,6 +220,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -210,8 +230,7 @@ The type must be a positive integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,6 +240,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -228,7 +250,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -238,13 +259,15 @@ Accept wildcard characters: False ``` ### -ChangeSyncKnowledge + +> Applicable: SharePoint Server Subscription Edition + Specifies Groove sync client to resync their content when a Content Database attach is used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -254,13 +277,15 @@ Accept wildcard characters: False ``` ### -DatabaseAccessCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the credential for the SPDataAccess role. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -270,13 +295,15 @@ Accept wildcard characters: False ``` ### -UseLatestSchema + +> Applicable: SharePoint Server Subscription Edition + Specifies to use the latest schema. In an on-premises environment, this parameter will have no effect at all. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentJob.md index c4f133103..bb6ad31ae 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentJob.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Deployment Job" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false ``` @@ -41,6 +41,9 @@ The job is configured to be an incremental job with no schedule. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new content deployment job. The type must be a valid name of a content deployment job; for example, DeployJob1. @@ -48,8 +51,7 @@ The type must be a valid name of a content deployment job; for example, DeployJo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -SPContentDeploymentPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the deployment path to associate with the new deployment job. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -66,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description for the content deployment job. The name can be a maximum of 4096 alphanumeric characters. @@ -124,8 +135,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +145,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: SharePoint Server Subscription Edition + Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. The type must be a list of valid e-mail addresses. @@ -142,8 +155,7 @@ The type must be a list of valid e-mail addresses. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +165,9 @@ Accept wildcard characters: False ``` ### -EmailNotifications + +> Applicable: SharePoint Server Subscription Edition + Specifies how e-mail notifications are sent about this ContentDeploymentJob object. The type must be one of the following: @@ -166,8 +181,7 @@ The type must be one of the following: ```yaml Type: ContentDeploymentNotificationSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,6 +191,9 @@ Accept wildcard characters: False ``` ### -HostingSupportEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables special hosting- behavior. The default value is False. @@ -187,8 +204,7 @@ Therefore, when the HostingSupportEnabled parameter is set to True, the hoster c ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,13 +214,15 @@ Accept wildcard characters: False ``` ### -IncrementalEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that only incremental changes are deployed to the destination site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -214,6 +232,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server Subscription Edition + Sets the schedule for the deployment job. The type must be a valid SPSchedule object. @@ -221,8 +242,7 @@ The type must be a valid SPSchedule object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -232,14 +252,16 @@ Accept wildcard characters: False ``` ### -ScheduleEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies to enable the schedule for the deployment job. If the schedule is not enabled the job can be run only manually. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -249,6 +271,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Sets the scope of the deployment job. SPSites passed in must exist in the current path of the source site collection. The default scope is the entire site collection. @@ -259,8 +284,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -270,6 +294,9 @@ Accept wildcard characters: False ``` ### -SqlSnapshotSetting + +> Applicable: SharePoint Server Subscription Edition + Creates a database snapshot of the source SharePoint Foundation content database to use for the export process. The type must be one of the following values: @@ -282,8 +309,7 @@ The CreateNew value requires thatSQL Server Enterprise Edition be installed. ```yaml Type: ContentDeploymentSqlSnapshotSetting Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -293,6 +319,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -300,7 +329,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentPath.md index 4078310af..76df645b9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPContentDeploymentPath.md @@ -31,7 +31,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------------- +### EXAMPLE ```powershell $source = Get-SPSite "http://source/" $credentials=Get-Credential @@ -44,6 +44,9 @@ The path is enabled and configured to keep temporary files on job failure. ## PARAMETERS ### -DestinationCentralAdministrationURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Central Administration URL for the destination farm. The type must be a valid URL, in the form http://server_name. @@ -51,8 +54,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -62,6 +64,9 @@ Accept wildcard characters: False ``` ### -DestinationSPSite + +> Applicable: SharePoint Server Subscription Edition + Specifies the destination site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. @@ -69,8 +74,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -DestinationSPWebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the destination Web application. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -87,8 +94,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new content deployment path. The type must be a valid name of a content deployment path; for example, DeployPath1. @@ -105,8 +114,7 @@ The type must be a valid name of a content deployment path; for example, DeployP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -116,6 +124,9 @@ Accept wildcard characters: False ``` ### -PathAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies the user ID that is an administrator on the Central Administration page on the destination farm. The type must be a valid SharePoint user. @@ -123,8 +134,7 @@ The type must be a valid SharePoint user. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -134,6 +144,9 @@ Accept wildcard characters: False ``` ### -SourceSPSite + +> Applicable: SharePoint Server Subscription Edition + Specifies the source site collection for the deployment path. Must be a site collection in the source specified in the SourceSPWebApplication parameter. @@ -142,8 +155,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -153,6 +165,9 @@ Accept wildcard characters: False ``` ### -SourceSPWebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the source Web application for the deployment path. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -160,8 +175,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -171,6 +185,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -182,8 +199,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +209,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: SharePoint Server Subscription Edition + Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. The type must be one of the following values: WindowsAuth or BasicAuth. @@ -200,8 +219,7 @@ The type must be one of the following values: WindowsAuth or BasicAuth. ```yaml Type: PathAuthenticationOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -211,13 +229,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on compression during the export. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,6 +247,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -234,7 +257,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -244,6 +266,9 @@ Accept wildcard characters: False ``` ### -DeploySecurityInformation + +> Applicable: SharePoint Server Subscription Edition + Specifies the user and group information to include during the export operation for this content deployment path. The default value is All. @@ -255,8 +280,7 @@ No user information defined in the DAP or LDAP servers is included. ```yaml Type: SPIncludeSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -266,6 +290,9 @@ Accept wildcard characters: False ``` ### -DeployUserNamesEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to include user names during a deployment. Valid values are one of the following: @@ -276,8 +303,7 @@ Valid values are one of the following: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -287,6 +313,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Sets the description for the content deployment path. The description can contain a maximum of 4096 alphanumeric characters. @@ -295,8 +324,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -306,13 +334,15 @@ Accept wildcard characters: False ``` ### -EventReceiversEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -322,6 +352,9 @@ Accept wildcard characters: False ``` ### -KeepTemporaryFilesOptions + +> Applicable: SharePoint Server Subscription Edition + Specifies that temporary files are kept after content deployment is finished. The type must be one of the following values: Never, Always, or OnFailure. @@ -329,8 +362,7 @@ The type must be one of the following values: Never, Always, or OnFailure. ```yaml Type: TemporaryFilesOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -340,13 +372,15 @@ Accept wildcard characters: False ``` ### -PathEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables the new content deployment path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -356,6 +390,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -363,7 +400,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAdminComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAdminComponent.md index 36a32d04c..903953b9d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAdminComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAdminComponent.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -42,13 +42,14 @@ This example adds a new Search Administration Component to the inactive topology ### -SearchServiceInstance +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance that will host the new admin component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new admin component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAnalyticsProcessingComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAnalyticsProcessingComponent.md index 9a4d17ca3..9abf6e75a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAnalyticsProcessingComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchAnalyticsProcessingComponent.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -42,13 +42,14 @@ This example adds a new Search Analytics Processing Component to the inactive to ### -SearchServiceInstance +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance that will host the new analytics processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new analytics processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,13 +120,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentEnrichmentConfiguration.md index fb0d058ee..9b5b6c85e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $config = New-SPEnterpriseSearchContentEnrichmentConfiguration ``` @@ -36,6 +36,9 @@ This example creates a new ContentEnrichmentConfiguration object. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,8 +50,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentProcessingComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentProcessingComponent.md index 080c95f3c..cff0b3d96 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentProcessingComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchContentProcessingComponent.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -42,15 +42,15 @@ This example adds a new Search Content Processing Component to the inactive topo ### -SearchServiceInstance -Specifies the search service instance that will host the new content processing component. +> Applicable: SharePoint Server Subscription Edition +Specifies the search service instance that will host the new content processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,13 +60,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new content processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,13 +121,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlComponent.md index 05a7320aa..46507adce 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlComponent.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -42,15 +42,15 @@ This example adds a new Search Crawl Component to the inactive topology for the ### -SearchServiceInstance -Specifies the search service instance that will host the new crawl component. +> Applicable: SharePoint Server Subscription Edition +Specifies the search service instance that will host the new crawl component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,13 +60,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new crawl component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,13 +121,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlContentSource.md index 965453f8f..ab8fe61a4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlContentSource.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlContentSource -SearchApplication $ssa -Type File -name FileServer -StartAddresses file://someserver/public @@ -42,6 +42,8 @@ This example creates a new content source of type file to crawl a file system. ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,12 +53,10 @@ When the Global parameter is used, all objects are contained in the global store If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -67,16 +67,16 @@ Accept wildcard characters: False ### -BDCApplicationProxyGroup +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy to use for a business type content source. This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -87,16 +87,16 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,17 +107,17 @@ Accept wildcard characters: False ### -CrawlPriority +> Applicable: SharePoint Server Subscription Edition + Specifies the priority of this content source. The value must be one of the following integers: 1= Normal, 2=High. - ```yaml Type: CrawlPriority Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,15 +128,15 @@ Accept wildcard characters: False ### -CustomProtocol -Specifies the custom protocol, handled by the custom connector, to use for this content source. +> Applicable: SharePoint Server Subscription Edition +Specifies the custom protocol, handled by the custom connector, to use for this content source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -147,15 +147,15 @@ Accept wildcard characters: False ### -LOBSystemSet -Specifies a comma-separated list of Business Data Connectivity metadata store system names and system instance names for a business type content source. +> Applicable: SharePoint Server Subscription Edition +Specifies a comma-separated list of Business Data Connectivity metadata store system names and system instance names for a business type content source. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,15 +166,15 @@ Accept wildcard characters: False ### -MaxPageEnumerationDepth -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. +> Applicable: SharePoint Server Subscription Edition +Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,15 +185,15 @@ Accept wildcard characters: False ### -MaxSiteEnumerationDepth -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. +> Applicable: SharePoint Server Subscription Edition +Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,17 +204,17 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the content source to create. The type must be a valid name of a ContentSource object (for example, ContentSource1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -225,17 +225,17 @@ Accept wildcard characters: False ### -SearchApplication +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search service application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -246,6 +246,8 @@ Accept wildcard characters: False ### -SharePointCrawlBehavior +> Applicable: SharePoint Server Subscription Edition + Specifies crawl behavior for a sharepoint type content source. The behavior can be either: @@ -254,12 +256,10 @@ CrawlSites to crawl only particular site collections. CrawlVirtualServers to crawl the entire server and all site collections on the server. - ```yaml Type: SharePointCrawlBehavior Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -270,17 +270,17 @@ Accept wildcard characters: False ### -StartAddresses +> Applicable: SharePoint Server Subscription Edition + Specifies the comma-separated list of URLs at which to start a crawl for this content source. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -291,18 +291,18 @@ Accept wildcard characters: False ### -Tag +> Applicable: SharePoint Server Subscription Edition + Specifies the URL for the page to modify the settings for a custom content source. The string that specifies the URL can contain a maximum of 1,024 characters. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -313,7 +313,9 @@ Accept wildcard characters: False ### -Type -Specifies the name of the content source type. +> Applicable: SharePoint Server Subscription Edition + +Specifies the name of the content source type. The value Business is for the Business Data Connectivity metadata store. The value Exchange is for Microsoft Exchange public folders. The value Custom is for a custom content source type. @@ -321,12 +323,10 @@ The value Custom is for a custom content source type. The type must be the valid name of a content source type; for example, custom. - ```yaml Type: ContentSourceType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -337,16 +337,16 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlCustomConnector.md index 45532cc08..d10dc5ba9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlCustomConnector.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlCustomConnector -SearchApplication $ssa -ModelFilePath \\models\myFileTypeModel.mft -Protocol "mftml://" @@ -40,13 +40,15 @@ This example creates a custom connector for a file type whose model is located a ## PARAMETERS ### -ModelFilePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path to a model file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Protocol + +> Applicable: SharePoint Server Subscription Edition + Specifies the string version of the protocol; for example, dctm://. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +76,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that is associated with the protocol. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object @@ -79,8 +86,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +110,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +120,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -129,13 +139,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the custom connector that appears on the SharePoint Central Administration Web site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlDatabase.md index a4c5126b2..49143dfe3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlDatabase.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlDatabase -SearchApplication $ssa -DatabaseName newCrawlDB @@ -40,6 +40,9 @@ This example creates a new crawl database named newCrawlDB for the mySearchServi ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. @@ -47,8 +50,7 @@ The type must be a valid name of a SQL Server database; for example, CrawlStoreD ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +94,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,13 +123,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the password for the Microsoft SQL Server database server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +141,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -138,8 +151,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,13 +161,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name specified in the Database Server parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -165,13 +179,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Server that is used for failover when SQL Server mirroring is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -181,6 +197,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -188,7 +207,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlExtension.md index 554910785..d718cce31 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlExtension.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlExtension -Name "pdf" -SearchApplication $ssa @@ -40,13 +40,15 @@ This example adds the PDF file type to the list of file name extensions to inclu ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new file name extension. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the extension collection. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -63,8 +68,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +92,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlMapping.md index 10a48be36..469604380 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlMapping.md @@ -26,10 +26,9 @@ The New-SPEnterpriseSearchCrawlMapping cmdlet is run when the search functionali For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlMapping -SearchApplication $ssa -Url "file://location1" -Target "https://location2" @@ -40,6 +39,9 @@ This example will change the query results link from the file share where the it ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the source URI for the crawl mapping. The type must be a valid URL, in the form https://server_name. @@ -47,8 +49,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -65,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: SharePoint Server Subscription Edition + Specifies the target URI for the crawl mapping to get. The type must be a valid URI; for example, file:\\\\ server_name\sitedocs. @@ -84,7 +90,6 @@ The type must be a valid URI; for example, file:\\\\ server_name\sitedocs. Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +113,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlRule.md index 5c3aea4e5..3bce7862f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchCrawlRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new crawl rule. - ## SYNTAX ``` @@ -24,16 +23,14 @@ New-SPEnterpriseSearchCrawlRule [-AccountName ] [-AccountPassword [-WhatIf] [] ``` - ## DESCRIPTION The `New-SPEnterpriseSearchCrawlRule` cmdlet creates special rules for crawling items that are contained in the specified path. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Path https://ExampleSharePointSite -CrawlAsHttp 1 -Type InclusionRule @@ -42,18 +39,18 @@ New-SPEnterpriseSearchCrawlRule -SearchApplication $ssa -Path https://ExampleSha This example creates an inclusion type crawl rule for the site at https://ExampleSharePointSite. The rule specifies that the site be crawled as an HTTP site. - ## PARAMETERS ### -AccountName -Specifies the account to use when applying the crawl rule. +> Applicable: SharePoint Server Subscription Edition + +Specifies the account to use when applying the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,14 +60,15 @@ Accept wildcard characters: False ``` ### -AccountPassword -Specifies the account to use when applying the crawl rule. +> Applicable: SharePoint Server Subscription Edition + +Specifies the account to use when applying the crawl rule. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,12 +89,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,6 +102,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the following authentication types to access matching URLs: BasicAccountRuleAccess -- Specifies the account name and password that are required for this authentication type. @@ -117,12 +119,10 @@ CookieRuleAccess -- Specifies private parameters and a list of error pages that AnonymousAccess-- Specifies that the matching URLs have to be accessed anonymously. - ```yaml Type: CrawlRuleAuthenticationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,15 +132,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -150,14 +151,15 @@ Accept wildcard characters: False ``` ### -ContentClass -Specifies the string that is sent to the protocol handler for any content that matches the crawl rule. +> Applicable: SharePoint Server Subscription Edition + +Specifies the string that is sent to the protocol handler for any content that matches the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,14 +169,15 @@ Accept wildcard characters: False ``` ### -CrawlAsHttp -Specifies whether the crawler should crawl content from a hierarchical content source as HTTP content. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the crawler should crawl content from a hierarchical content source as HTTP content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,14 +187,15 @@ Accept wildcard characters: False ``` ### -FollowComplexUrls -Specifies whether the index engine should crawl content with URLs that contain a question mark (?). +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the index engine should crawl content with URLs that contain a question mark (?). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,16 +205,17 @@ Accept wildcard characters: False ``` ### -IsAdvancedRegularExpression + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the rule has a full regular expression syntax. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -220,14 +225,15 @@ Accept wildcard characters: False ``` ### -Path -Specifies a unique path to which a crawl rule applies. +> Applicable: SharePoint Server Subscription Edition + +Specifies a unique path to which a crawl rule applies. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -237,13 +243,15 @@ Accept wildcard characters: False ``` ### -PluggableSecurityTimmerId + +> Applicable: SharePoint Server Subscription Edition + {{Fill PluggableSecurityTimmerId Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -253,16 +261,17 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server Subscription Edition + Defines where in the list of crawl rules this crawl rule should be applied. The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -272,16 +281,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Search application that is associated with the crawl rule to be modified. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -291,14 +301,15 @@ Accept wildcard characters: False ``` ### -SuppressIndexing -Specifies whether the crawler should exclude the content of items that this rule applies to from the content index. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the crawler should exclude the content of items that this rule applies to from the content index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -308,15 +319,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of crawl rule. A value of zero (0) includes the rule, a value of 1 excludes the rule. - ```yaml Type: CrawlRuleType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -326,15 +338,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchFileFormat.md index f2b429344..7ca0dd09b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchFileFormat.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new file format to the parsing system. - ## SYNTAX ``` @@ -32,10 +31,9 @@ The system will only consider the new file format after a restart of the content For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchFileFormat -SearchApplication $ssa -FormatId foo -FormatName FooApp -MimeType "text/foo" @@ -43,18 +41,18 @@ New-SPEnterpriseSearchFileFormat -SearchApplication $ssa -FormatId foo -FormatNa This example uses the `New-SPEnterpriseSearchFileFormat` cmdlet to add a new file format FooApp with the belonging file name extension foo to the parsing system in the search service application referenced by $ssa - ## PARAMETERS ### -FormatId -Specifies the file name extension of the format to add. +> Applicable: SharePoint Server Subscription Edition + +Specifies the file name extension of the format to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,16 +62,17 @@ Accept wildcard characters: False ``` ### -FormatName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the format to add. Usually this is the name of the application handling the format. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -83,14 +82,15 @@ Accept wildcard characters: False ``` ### -MimeType -Specifies the mime type of the format to add. +> Applicable: SharePoint Server Subscription Edition + +Specifies the mime type of the format to add. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -100,14 +100,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application for which to add the new file format. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -117,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -128,8 +133,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -156,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchIndexComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchIndexComponent.md index ceaf0aeb3..4454116fd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchIndexComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchIndexComponent.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new index component for the given topology and search service instance. - ## SYNTAX ``` @@ -26,10 +25,9 @@ New-SPEnterpriseSearchIndexComponent -SearchServiceInstance Applicable: SharePoint Server Subscription Edition + +Specifies the search service instance that will host the new index component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,13 +58,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new index component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,13 +119,15 @@ Accept wildcard characters: False ``` ### -IndexPartition + +> Applicable: SharePoint Server Subscription Edition + Specifies the index partition number to assign to the new search index component. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,19 +137,20 @@ Accept wildcard characters: False ``` ### -RootDirectory + +> Applicable: SharePoint Server Subscription Edition + Specifies the root directory that will hold the index location for the new search index component. This is needed if you want to isolate the index on dedicated discs in order to avoid I/O contention with other parts of the system, other system sharing the same disks, or because you do not want to risk the index filling up the OS disk (generally C: ) If you specify the root directory to be the root of a volume, e.g. -E:, the index will not be cleaned up if you delete the SSA. +E:, the index will not be cleaned up if you delete the SSA. You will then have to delete the SSA manually. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,13 +160,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLanguageResourcePhrase.md index 7ed752f70..54f695a58 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLanguageResourcePhrase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a language resource phrase to a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The `New-SPEnterpriseSearchLanguageResourcePhrase` cmdlet adds a query keyword p For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language en-us -Type QuerySuggestionBlockList -Name secret @@ -38,10 +36,12 @@ New-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $ssa -Language e This example adds a new entry to the QuerySuggestionBlockList for the en-us language. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,12 +50,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -65,15 +63,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -83,16 +82,17 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Adds the phrase for the specified source language. The type must be a valid name of a language; for example, en-us or ja-jp. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,17 +102,18 @@ Accept wildcard characters: False ``` ### -Mapping + +> Applicable: SharePoint Server Subscription Edition + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,16 +123,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the term to add to the list specified in the Type parameter. The type must be a valid name of a language resource phrase (for example, LanguageResourcePhrase1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -141,6 +143,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -150,12 +155,10 @@ The owner must be one of the following valid levels: - Site Collection - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -165,16 +168,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -184,14 +188,15 @@ Accept wildcard characters: False ``` ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server Subscription Edition + +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +206,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of the new phrase. The type must be one of the following valid types of phrases: @@ -210,12 +218,10 @@ The type must be one of the following valid types of phrases: - Nickname - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -225,15 +231,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLinksDatabase.md index 71124e55c..63e6e5399 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchLinksDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new links database for a search service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchLinksDatabase -DatabaseName LinksDB_1 -SearchApplication $ssa @@ -39,18 +37,19 @@ New-SPEnterpriseSearchLinksDatabase -DatabaseName LinksDB_1 -SearchApplication $ This example adds a new links database LinksDB_1 to the search service application. - ## PARAMETERS ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the links database to obtain. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,14 +59,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the account to connect to the database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server to use for the host SQL database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the account to connect to the database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server to use for failover in the case of SQL Server mirroring. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +193,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +203,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCategory.md index b1b62aef1..91f8c345d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCategory.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a crawled property category to a search service application. - ## SYNTAX ``` @@ -28,13 +27,12 @@ SPEnterpriseSearchMetadataCategory represents a category in the enterprise searc For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell -$ssa = Get-SPEnterpriseSearchServiceApplication -$guid = [System.Guid]::NewGuid() +$ssa = Get-SPEnterpriseSearchServiceApplication +$guid = [System.Guid]::NewGuid() New-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Name MyCategory -DiscoverNewProperties $true -PropSet $guid ``` @@ -45,6 +43,9 @@ Therefore, new crawled properties will be added to the MyCategory metadata categ ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +54,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,14 +67,15 @@ Accept wildcard characters: False ``` ### -AutoCreateNewManagedProperties -Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. +> Applicable: SharePoint Server Subscription Edition + +Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. ```yaml Type: Boolean Parameter Sets: (All) Aliases: auto -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -85,15 +85,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -103,14 +104,15 @@ Accept wildcard characters: False ``` ### -DiscoverNewProperties -Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. +> Applicable: SharePoint Server Subscription Edition + +Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. ```yaml Type: Boolean Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,14 +122,15 @@ Accept wildcard characters: False ``` ### -MapToContents -Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. +> Applicable: SharePoint Server Subscription Edition + +Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. ```yaml Type: Boolean Parameter Sets: (All) Aliases: m -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,16 +140,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the new metadata category. The type must be a valid name of a metadata category, for example, MetadataCategory1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -156,6 +160,9 @@ Accept wildcard characters: False ``` ### -PropSet + +> Applicable: SharePoint Server Subscription Edition + Creates a new metadata category with the specified property set. Note that the specified property set is the identifier of the category. @@ -163,12 +170,10 @@ Therefore, two categories cannot share a property set. The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -178,16 +183,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the enterprise search metadata categories. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -197,15 +203,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCrawledProperty.md index d0245369f..1e86551ec 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataCrawledProperty.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a crawled property. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Or, crawled properties are automatically created during regular crawls (see SPEn For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Identity People @@ -43,10 +41,12 @@ New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name "MyC This example maps the new crawled property MyCrawlProp to the People metadata category for the default search service application. The mapping uses the constraints from the existing People category. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,12 +55,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,16 +68,17 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies to which metadata category the crawled property should be added The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - ```yaml Type: CategoryPipeBind Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -89,15 +88,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,15 +107,16 @@ Accept wildcard characters: False ``` ### -IsMappedToContents + +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled property should be mapped to managed properties. Specify true to map a crawled property to a managed property. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,15 +126,16 @@ Accept wildcard characters: False ``` ### -IsNameEnum + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the crawled property name is of type integer. Specified by true or false. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: ie -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -143,16 +145,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the new crawled property. The type must be a valid crawled property name, for example "urn:schemas-microsoft-com:sharepoint:portal:profile:UserName" - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -162,16 +165,17 @@ Accept wildcard characters: False ``` ### -PropSet + +> Applicable: SharePoint Server Subscription Edition + Specifies the property set that belongs to an existing category. A valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) Aliases: p -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -181,16 +185,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawled property. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -200,16 +205,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -219,16 +225,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -238,19 +245,21 @@ Accept wildcard characters: False ``` ### -VariantType + +> Applicable: SharePoint Server Subscription Edition + Adds the crawled property as the specified variant type. For more information about valid values for this property, see VARIANT Type Constants (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409) (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409). The type must be an integer that specifies the variant data type of the property set. -> [!NOTE] +> [!NOTE] > This parameter is required although the value is not used in SharePoint Server 2013 through SharePoint Server 2019. You will see an Obsolete warning when running the cmdlet. You may ignore this message. ```yaml Type: Int32 Parameter Sets: (All) Aliases: vt -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -260,15 +269,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataManagedProperty.md index 004bb6856..86ccfffe8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataManagedProperty.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a managed property to a shared search application. - ## SYNTAX ``` @@ -31,10 +30,9 @@ SPEnterpriseSearchMetadataManagedProperty represents a managed property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchMetadataManagedProperty -Name AboutMeUpdate -SearchApplication $ssa -Type 4 @@ -42,10 +40,12 @@ New-SPEnterpriseSearchMetadataManagedProperty -Name AboutMeUpdate -SearchApplica This example creates a new managed property named AboutMeUpdate in the default search service application and sets it type to DateTime. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,12 +54,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -69,15 +67,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -87,14 +86,15 @@ Accept wildcard characters: False ``` ### -DefaultForQueryIndependentRank -Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). +> Applicable: SharePoint Server Subscription Edition + +Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). ```yaml Type: UInt32 Parameter Sets: (All) Aliases: def -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -104,16 +104,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Adds a description to the metadata managed property. The type must be a valid string. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -123,6 +124,9 @@ Accept wildcard characters: False ``` ### -EnabledForQueryIndependentRank + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. The type must be one of the following query-independent ranking features in the custom model XML: @@ -131,12 +135,10 @@ The type must be one of the following query-independent ranking features in the - categoryFeature - languageFeature - ```yaml Type: Boolean Parameter Sets: (All) Aliases: qir -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,14 +148,15 @@ Accept wildcard characters: False ``` ### -EnabledForScoping -Specifies that the managed property can be used in a scope definition. +> Applicable: SharePoint Server Subscription Edition + +Specifies that the managed property can be used in a scope definition. ```yaml Type: Boolean Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,14 +166,15 @@ Accept wildcard characters: False ``` ### -FullTextQueriable -Specifies that the managed property can be used in enterprise search SQL queries. +> Applicable: SharePoint Server Subscription Edition + +Specifies that the managed property can be used in enterprise search SQL queries. ```yaml Type: Boolean Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -180,13 +184,15 @@ Accept wildcard characters: False ``` ### -IncludeInAlertSignature + +> Applicable: SharePoint Server Subscription Edition + Specifies whether this managed property should be included in the alert signature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: ia -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -196,14 +202,15 @@ Accept wildcard characters: False ``` ### -IncludeInMd5 -Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. +> Applicable: SharePoint Server Subscription Edition + +Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: im5 -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -213,16 +220,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new managed property. The type must be a valid name of a managed property, for example, ManagedProperty1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -232,15 +240,16 @@ Accept wildcard characters: False ``` ### -NameNormalized + +> Applicable: SharePoint Server Subscription Edition + Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. If value is set to true, the values are normalized. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nn -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -250,14 +259,15 @@ Accept wildcard characters: False ``` ### -NoWordBreaker -Specifies that the values for this managed property are processed by a word breaker. +> Applicable: SharePoint Server Subscription Edition + +Specifies that the values for this managed property are processed by a word breaker. ```yaml Type: Boolean Parameter Sets: (All) Aliases: nw -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -267,14 +277,15 @@ Accept wildcard characters: False ``` ### -Queryable -Specifies whether this managed property is queryable or not. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether this managed property is queryable or not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: q -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -284,14 +295,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. +> Applicable: SharePoint Server Subscription Edition + +Specifies that duplicate values for the managed property are removed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rd -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -301,15 +313,16 @@ Accept wildcard characters: False ``` ### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. -Otherwise, all mapped crawled properties that have a value are copied. +> Applicable: SharePoint Server Subscription Edition + +Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. +Otherwise, all mapped crawled properties that have a value are copied. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rp -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -319,14 +332,15 @@ Accept wildcard characters: False ``` ### -Retrievable -Specifies whether this managed property is retrievable or not. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether this managed property is retrievable or not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -336,13 +350,15 @@ Accept wildcard characters: False ``` ### -SafeForAnonymous + +> Applicable: SharePoint Server Subscription Edition + Specifies whether it is acceptable to display the contents of the property in search results for anonymous searches. ```yaml Type: Boolean Parameter Sets: (All) Aliases: sfa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -352,16 +368,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the managed property collection. The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -371,16 +388,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -390,16 +408,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -409,6 +428,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the data type of the new managed property. The type must be one of the following data types: @@ -427,12 +449,10 @@ The type must be one of the following data types: 7 = Double - ```yaml Type: Int32 Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -442,14 +462,15 @@ Accept wildcard characters: False ``` ### -UserFlags -Reserved for future use. +> Applicable: SharePoint Server Subscription Edition + +Reserved for future use. ```yaml Type: Int16 Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -459,15 +480,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataMapping.md index b18ecc0b2..60fc57ce3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchMetadataMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a managed property mapping. - ## SYNTAX ``` @@ -28,10 +27,9 @@ SPEnterpriseSearchMetadataMapping represents a snapshot of a mapping between a m For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName @@ -48,6 +46,9 @@ The VarientType parameter is marked as obsolete but is still required when execu ## PARAMETERS ### -CrawledProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawled property to map. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -55,8 +56,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,6 +66,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to which the crawled property should be mapped. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -73,8 +76,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the metadata mapping. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -91,8 +96,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +120,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,6 +149,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mapping returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -148,8 +159,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,6 +169,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mapping returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -166,8 +179,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,6 +189,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -184,7 +199,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryAuthority.md index 646cd4f14..dc6b93845 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an authoritative page to a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryAuthority -SearchApplication $ssa -Url https://contoso.com -Level 1.5 @@ -38,10 +36,12 @@ New-SPEnterpriseSearchQueryAuthority -SearchApplication $ssa -Url https://contos This example designates the URL https://contoso.com as an authoritative page with a relative importance of 1.5. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the query authority page to create. The type must be a valid URL, in the form https://server_name. @@ -49,8 +49,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server Subscription Edition + Specifies the level of the new authoritative page. Authoritative pagesare expert pages that link to the most relevant information. A search service application can have multiple authoritative pages. @@ -70,7 +72,6 @@ This parameter may receive a floating point value of 0.0 - 2.0, where 0.0 has th Type: Single Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the authority page collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -103,8 +109,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -125,8 +133,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -160,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryDemoted.md index 16d17207a..f84fb28e9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryDemoted.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a demoted site rule to a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Query demoted sites are de-emphasized in relevance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryDemoted -Url https://examplesite -SearchApplication $ssa @@ -38,10 +36,12 @@ New-SPEnterpriseSearchQueryDemoted -Url https://examplesite -SearchApplication $ This example adds a demoted site rule for the URL https://examplesite.com to a search service application. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the new demoted site rule. The type must be a valid URL, in the form https://server_name. @@ -49,8 +49,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the demoted site rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -83,8 +87,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryKeyword.md index d8ce91ed5..5ea5c6eff 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryKeyword.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a keyword term to a shared search application. - ## SYNTAX ``` @@ -31,20 +30,21 @@ You cannot use this cmdlet after a site collection is upgraded to SharePoint Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPEnterpriseSearchQueryKeyword -Term Tangible -Site https://myserver/sites/team ``` This example creates a new query keyword for the site https://myserver/sites/team with the term Tangible. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +53,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,15 +66,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -86,16 +85,17 @@ Accept wildcard characters: False ``` ### -Contact + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name associated with the new keyword. The type must be a valid user name; for example, KeywordUser1. - ```yaml Type: String Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,16 +105,17 @@ Accept wildcard characters: False ``` ### -Definition + +> Applicable: SharePoint Server Subscription Edition + Specifies the definition of the new keyword term. The type must be a valid string; for example, a keyword term definition. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,17 +125,18 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -144,17 +146,18 @@ Accept wildcard characters: False ``` ### -ReviewDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the review date of the keyword term. The default value is MaxDate. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -164,16 +167,17 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Associates the new keyword term to the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. - ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -183,17 +187,18 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the activation date for the keyword term. The default value is the current date. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -203,16 +208,17 @@ Accept wildcard characters: False ``` ### -Term + +> Applicable: SharePoint Server Subscription Edition + Specifies the keyword term to create. The type must be a valid string that contains a keyword term (for example, KeywordTerm1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -222,15 +228,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryProcessingComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryProcessingComponent.md index 014e4448f..ddee31bad 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryProcessingComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryProcessingComponent.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new query processing component for the given topology and search service instance. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The change is effectuated when the search topology is enabled. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance $ssa = Get-SPEnterpriseSearchServiceApplication @@ -42,14 +40,15 @@ This example adds a new Search Query Processing Component to the inactive topolo ## PARAMETERS ### -SearchServiceInstance -Specifies the search service instance that will host the new query processing component. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search service instance that will host the new query processing component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology where the new query processing component should be added. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the search topology. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScope.md index 013bd5eb4..121b30314 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScope.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a query results scope to a shared search application. - ## SYNTAX ``` @@ -35,10 +34,9 @@ SPEnterpriseSearchQueryScope represents a query results scope used by all shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must crawl" -DisplayInAdminUI $true -SearchApplication $ssa @@ -46,20 +44,20 @@ New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must cra This example adds a scope named MustCrawl that will be displayed in the administration UI to the search service application named MySSA. - ## PARAMETERS ### -AlternateResultsPage + +> Applicable: SharePoint Server Subscription Edition + Specifies the location to display results for the new query scope. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: a -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -69,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,12 +78,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,17 +91,18 @@ Accept wildcard characters: False ``` ### -CompilationType + +> Applicable: SharePoint Server Subscription Edition + Specifies the compilation type of the new scope. The value 0 specifies the conditionally compiled scope type and the value 1 specifies the always compiled scope type. The type must be either of the following: 0 or 1. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,15 +112,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,16 +131,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Adds a description of the new query scope. The type must be a valid string; for example, a description of a query scope. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -149,15 +151,16 @@ Accept wildcard characters: False ``` ### -DisplayInAdminUI + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new scope is displayed in the administration application user interface (UI). The default setting is to hide the new scope in the administration application UI. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: disp -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -167,13 +170,15 @@ Accept wildcard characters: False ``` ### -ExtendedSearchFilter + +> Applicable: SharePoint Server Subscription Edition + {{Fill ExtendedSearchFilter Description}} ```yaml Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -183,16 +188,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the scope to create. The type must be a valid name of a scope (for example, Scope1). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -202,16 +208,17 @@ Accept wildcard characters: False ``` ### -OwningSiteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint site that is associated with the new scope. The type must be a valid SharePoint site URL, in the form https://server_name. - ```yaml Type: Uri Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -221,16 +228,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -240,15 +248,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScopeRule.md index 038b71fc0..01a6c4bdc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchQueryScopeRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a shared scope rule to a query scope. - ## SYNTAX ``` @@ -36,10 +35,9 @@ SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -48,10 +46,12 @@ New-SPEnterpriseSearchQueryScopeRule -Scope $scope -RuleType AllContent -Url htt This example creates a new scope rule of type AllContent for the URL https://criticalSite. - ## PARAMETERS ### -RuleType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of scope rule to create. The type must be one of the following values: AllContent, Url, or PropertyQuery. @@ -60,7 +60,6 @@ The type must be one of the following values: AllContent, Url, or PropertyQuery. Type: String Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Applies the query scope rule to the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -78,7 +80,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the results URL that is associated with the query scope rule. The type must be a valid URL, in the form https://server_name. @@ -96,7 +100,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -117,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -FilterBehavior + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of scope rule to create for the query scope. The default value is Include. @@ -154,7 +164,6 @@ The type must be one of the following values: Exclude, Include, or Require. Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -164,6 +173,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to use for the PropertyQuery scope rule. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a managed property (for example, ManagedProperty1); or an instance of a valid ManagedProperty object. @@ -172,7 +184,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ManagedPropertyPipeBind Parameter Sets: (All) Aliases: mname -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -MatchingString + +> Applicable: SharePoint Server Subscription Edition + Specifies the string to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: text -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -198,13 +211,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server Subscription Edition + Specifies the property value to use when matching the PropertyQuery rule type. ```yaml Type: String Parameter Sets: (All) Aliases: value -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -221,8 +239,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -UrlScopeRuleType + +> Applicable: SharePoint Server Subscription Edition + Specifies the value to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: ut -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -255,7 +277,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchRankingModel.md index b0f7dfda5..9b37f2316 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchRankingModel.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a ranking model to a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The name, description and identifier (ID) for the new ranking model are containe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SPWeb -SPWeb https://sharepoint/team @@ -40,10 +38,12 @@ New-SPEnterpriseSearchRankingModel -SearchApplication $ssa -Owner $owner -Rankin This example creates a ranking model for the site https://sharepoint/team for the search service application Search Service Application from the file rankModel.xml which is stored in the current directory. - ## PARAMETERS ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -52,7 +52,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -RankingModelXML + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the XML representation of the new ranking model. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the ranking model. The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -85,8 +89,7 @@ The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a val ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultItemType.md index 4de2c46c6..2be16537d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultItemType.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new result item type. - ## SYNTAX ### New @@ -52,10 +51,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith" $rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252') @@ -84,13 +82,15 @@ Finally, the example defines the rule item type by its name, the rule collection ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the result item type. ```yaml Type: String -Parameter Sets: New +Parameter Sets: New, Copy Aliases: n -Applicable: SharePoint Server Subscription Edition Required: True Position: 2 @@ -99,27 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Copy -Aliases: n -Applicable: SharePoint Server Subscription Edition +### -Rules -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -Rules Specifies the collection of rules to evaluate the result properties against. ```yaml Type: PropertyRuleCollection -Parameter Sets: New +Parameter Sets: New, Copy Aliases: rule -Applicable: SharePoint Server Subscription Edition Required: True Position: 3 @@ -128,27 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: PropertyRuleCollection -Parameter Sets: Copy -Aliases: rule -Applicable: SharePoint Server Subscription Edition +### -RulePriority -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -RulePriority Specifies which priority the collection of rules has compared to other rules. ```yaml Type: Int32 Parameter Sets: (All) Aliases: priority -Applicable: SharePoint Server Subscription Edition Required: False Position: 4 @@ -158,13 +136,15 @@ Accept wildcard characters: False ``` ### -DisplayProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies which result properties to display. ```yaml Type: String Parameter Sets: (All) Aliases: dp -Applicable: SharePoint Server Subscription Edition Required: False Position: 5 @@ -174,6 +154,9 @@ Accept wildcard characters: False ``` ### -SourceID + +> Applicable: SharePoint Server Subscription Edition + Identifies the search result source that the result item type applies to. Leave this parameter blank to apply to all result sources. @@ -181,7 +164,6 @@ Leave this parameter blank to apply to all result sources. Type: Guid Parameter Sets: (All) Aliases: sid -Applicable: SharePoint Server Subscription Edition Required: False Position: 6 @@ -191,14 +173,16 @@ Accept wildcard characters: False ``` ### -DisplayTemplateUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the display template that shall be used for rendering the results. Specify an absolute URL. ```yaml Type: String -Parameter Sets: New +Parameter Sets: Copy, New Aliases: url -Applicable: SharePoint Server Subscription Edition Required: True Position: 7 @@ -207,27 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: Copy -Aliases: url -Applicable: SharePoint Server Subscription Edition +### -ExistingResultItemType -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -ExistingResultItemType Specifies an existing result item type to which new rules or displayed properties can be added. ```yaml Type: ResultItemTypePipeBind Parameter Sets: Copy Aliases: copy -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -237,13 +210,15 @@ Accept wildcard characters: False ``` ### -ExistingResultItemTypeOwner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which an existing result item type was created. ```yaml Type: SearchObjectOwner Parameter Sets: Copy Aliases: eo -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -253,13 +228,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -269,6 +246,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -280,8 +260,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -291,6 +270,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -298,7 +280,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -308,6 +289,9 @@ Accept wildcard characters: False ``` ### -OptimizeForFrequentUse + +> Applicable: SharePoint Server Subscription Edition + Enable this flag if you always want the properties of this result item type to be requested, regardless of whether the result type is triggered. This will improve performance as long as it is only enabled on the most frequently used result item types. @@ -315,7 +299,6 @@ This will improve performance as long as it is only enabled on the most frequent Type: Boolean Parameter Sets: (All) Aliases: opt -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -325,14 +308,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -342,14 +327,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -359,6 +346,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -366,7 +356,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultSource.md index c4d818de2..86fca6457 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchResultSource.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new result source. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Result Sources replace Search Scopes, which are now deprecated. This cmdlet supports the same create operations as are supported through the "Manage Result Sources" page in Central Administration, except the operations "Form Authentication" and "Cookie Authentication". For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -43,24 +41,24 @@ New-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Provid This example creates a new search service application level result source, named "Custom SharePoint Result Source". - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - + When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication type of the new result source. A specific set of authentication types are supported for each search provider type and, if parameter is not specified, the authentication type will default based on search provider type. @@ -80,16 +81,14 @@ When using a Local SharePoint Search/Local SharePoint People Search provider, th When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. +When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. All authentication types are listed in the enum FederationAuthType. - ```yaml Type: FederationAuthType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,19 +98,20 @@ Accept wildcard characters: False ``` ### -AutoDiscover + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to use automatic discovery of the Exchange server endpoint for the new result source. -Setting value to true ($true) states that automatic discovery should be used. +Setting value to true ($true) states that automatic discovery should be used. If not specified or set to false ($false), automatic discovery will not be used. Only applicable when using an Exchange search provider. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,15 +121,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -139,14 +140,15 @@ Accept wildcard characters: False ``` ### -Description -Specifies the description of the new result source. +> Applicable: SharePoint Server Subscription Edition + +Specifies the description of the new result source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,17 +158,18 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the new result source should be set as default or not, for the scope specified by the Owner parameter. Setting value to true ($true) states that the result source should be set as default. If not specified or set to false, the new result source will not be set as default. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,18 +179,19 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new result source. Names must be unique at each administrative level. For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -197,14 +201,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is created. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search object owner that defines the scope at which the corresponding result source is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -214,16 +219,17 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the user credentials to use to connect to the new result source. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -233,16 +239,17 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies the search provider to be used by the new result source. Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -252,6 +259,9 @@ Accept wildcard characters: False ``` ### -QueryTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies the query transformation template of the new result source. Incoming queries are changed according to the template, to use this new query text instead. @@ -262,12 +272,10 @@ For example, to only return OneNote items, set the new text to "{searchTerms} fi Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". Default value is {searchTerms}. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -277,11 +285,14 @@ Accept wildcard characters: False ``` ### -RemoteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection URL template of the new result source. Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1 and Exchange (if AutoDiscover is not turned on). -When using other search providers the parameter is ignored. +When using other search providers the parameter is ignored. For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. @@ -290,12 +301,10 @@ For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. For Exchange, specify the Exchange EWS URL from which to retrieve results. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -305,16 +314,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -324,18 +334,19 @@ Accept wildcard characters: False ``` ### -SsoId + +> Applicable: SharePoint Server Subscription Edition + Specifies the reverse proxy certificate Secure Store Id to use to connect to the new result source. Must be specified if authentication type (AuthenticationType) is set to FederationAuthType.SSO (Single Sign On). If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -345,16 +356,17 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name of the user credentials to use to connect to the new result source. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -364,15 +376,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSecurityTrimmer.md index 99becabd2..d39aac188 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSecurityTrimmer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a custom security trimmer to a shared search application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ SPEnterpriseSearchSecurityTrimmer represents a security trimmer that performs cu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -TypeName "SearchCustomSecurityTrimmer.CustomSecurityTrimmerPost, SearchCustomSecurityTrimmer, Version=1.0.0.0, Culture=neutral, PublicKeyToken=48e046c834625a88, processorArchitecture=MSIL" -Id 1 @@ -39,10 +37,12 @@ New-SPEnterpriseSearchSecurityTrimmer -SearchApplication $ssa -TypeName "SearchC This example adds a new custom security trimmer for trimming the returned result set. This new security trimmer is added to the search application by using the id 1. The strong named assembly contains the class CustomSecurityTrimmerPost, which implements the ISecurityTrimmerPost interface. - ## PARAMETERS ### -Id + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the security trimmer to use for the specified search application. If this parameter specifies an existing custom security trimmer, the trimmer will be removed and replaced with the custom trimmer. @@ -52,8 +52,7 @@ Remove the existing trimmer before you add a new one. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -RulePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the content path where the security trimmer will be applied. The string must be a valid URI in the form file:\\\\server_name\content, and it must correspond to an existing crawl rule. @@ -70,8 +72,7 @@ The string must be a valid URI in the form file:\\\\server_name\content, and it ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Adds the security trimmer to the specified search application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -88,8 +92,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -TypeName + +> Applicable: SharePoint Server Subscription Edition + Specifies the strong named assembly name of a security trimmer type. The strong name must refer to a type whose assembly is deployed to the global assembly cache on a query server and that type must implement the ISecurityTrimmerPre, ISecurityTrimmerPost or ISecurityTrimmer2 interface. Security trimming can be done in two places: before query execution (ISecurityTrimmerPre) or after the results set has returned (ISecurityTrimmerPost or ISecurityTrimmer2). @@ -107,8 +113,7 @@ For how to reference a strong name assembly, see https://msdn.microsoft.com/en-u ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -125,8 +133,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Properties + +> Applicable: SharePoint Server Subscription Edition + Specifies the name-value pairs that specify the configuration properties. The type must be in the following name/value pair format: Name1~Value1~Name2~Value2~ @@ -160,8 +172,7 @@ The type must be in the following name/value pair format: Name1~Value1~Name2~Val ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -178,7 +192,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplication.md index 29d8377da..a22f4e461 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a search service application to a farm. - ## SYNTAX ``` @@ -31,10 +30,9 @@ A farm can include multiple search service applications. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $appPool = New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account 'CONTOSO\ServiceApps' New-SPEnterpriseSearchServiceApplication -Name "Search Service Application" -ApplicationPool $appPool @@ -44,10 +42,12 @@ This example creates a new search service application named NewSSA in a new appl A search service application that is created in this manner will have active search topology, but no search components. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the names of the new search application. The type must be a valid name of a search application, for example, SearchApp1. @@ -55,8 +55,7 @@ The type must be a valid name of a search application, for example, SearchApp1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS application pool to use for the new search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL of a search application, in the form https://server_name; or an instance of a valid SPIisWebServiceApplicationPool object. @@ -73,8 +75,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -113,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the new search application. The type must be a valid name of a SQL Server database, for example, SearchAppDB1. @@ -130,8 +138,7 @@ The type must be a valid name of a SQL Server database, for example, SearchAppDB ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user ID that is used for accessing the search application database on SQL Server. The type must be a valid password. @@ -148,8 +158,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. @@ -166,8 +178,7 @@ The type must be a valid SQL Server host name, for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,6 +188,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user ID to use for accessing the search application SQL Server database. The type must be a valid user name, for example, SearchUserName1. @@ -184,8 +198,7 @@ The type must be a valid user name, for example, SearchUserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -195,17 +208,18 @@ Accept wildcard characters: False ``` ### -Partitioned + +> Applicable: SharePoint Server Subscription Edition + Specifies that the search service application uses web-hosted mode. Web-hosted mode segregates results for a given hosted subscription. This property has no effect on SharePoint Server 2019. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -215,6 +229,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -222,7 +239,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -232,13 +248,15 @@ Accept wildcard characters: False ``` ### -AdminApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the application pool to be used with the SearchAdminWebServiceApplication that is associated with SearchServiceApplication. If not specified, ApplicationPool will be used. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -248,13 +266,15 @@ Accept wildcard characters: False ``` ### -CloudIndex + +> Applicable: SharePoint Server Subscription Edition + When CloudIndex is true, this becomes a cloud Search service application that crawls on premises content in a cloud hybrid search solution. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -264,13 +284,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the SQL server that hosts the mirror instances of search databases. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplicationProxy.md index 6ae01a356..d6b56e40a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new search application proxy to a farm. - ## SYNTAX ### SSA @@ -43,10 +42,9 @@ For more information about how to use parameter sets, see Cmdlet Parameter Sets For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchServiceApplicationProxy -Name 'Search Service Application Proxy' -SearchApplication $ssa @@ -54,10 +52,12 @@ New-SPEnterpriseSearchServiceApplicationProxy -Name 'Search Service Application This example adds a search service application proxy to a search service application. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the search application proxy to create. The type must be a valid string, for example, SearchAppProxy1. @@ -65,8 +65,7 @@ The type must be a valid string, for example, SearchAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -76,6 +75,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI to the search application to use for search. The type must be a valid URI, in the form file:\\\\server_name\searchapp. @@ -83,8 +85,7 @@ The type must be a valid URI, in the form file:\\\\server_name\searchapp. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: SSA -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI to the search application to use for search. The type must be a valid URI, in the form file:\\\\server_name\searchapp. @@ -101,8 +105,7 @@ The type must be a valid URI, in the form file:\\\\server_name\searchapp. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +129,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -151,13 +158,15 @@ Accept wildcard characters: False ``` ### -MergeWithDefaultPartition + +> Applicable: SharePoint Server Subscription Edition + Merges the index partition for the proxy with the default index partition collection for the search service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,14 +176,16 @@ Accept wildcard characters: False ``` ### -Partitioned + +> Applicable: SharePoint Server Subscription Edition + Specifies that the search service application must use web-hosted mode. web-hosted mode segregates results for a given hosted subscription. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,6 +195,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -191,7 +205,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSiteHitRule.md index 6fc10d053..6786c476e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchSiteHitRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new site hit rule for a search application. - ## SYNTAX ``` @@ -27,27 +26,27 @@ The new site hit rule is used by all search service applications on the current For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPEnterpriseSearchSiteHitRule -Name myHost -Behavior 0 -HitRate 40 ``` This example creates a new site hit rule on the myHost host that limits to 40 the number of simultaneous requests. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + The name of the host to which the site hit rule should be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -Behavior + +> Applicable: SharePoint Server Subscription Edition + Defines a rule to be followed when the farm's search service crawls the given site. If a value of zero is specified, the hit rate is the maximum number of simultaneous requests. If a value of 1 is specified, then hit rate is the number of seconds to delay between requests to the server. @@ -64,8 +66,7 @@ If a value of zero is specified, the hit rate is the maximum number of simultane ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,13 +76,15 @@ Accept wildcard characters: False ``` ### -HitRate + +> Applicable: SharePoint Server Subscription Edition + Value to use for maximum requests or seconds of delay, according to behavior. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -98,8 +104,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service in the farm that hosts the crawl. The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet will be used. @@ -133,8 +143,7 @@ The type must be an instance of a valid SearchService object; otherwise, the loc ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -144,6 +153,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -151,7 +163,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchTopology.md index 9a89633e4..d77d34a0e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPEnterpriseSearchTopology.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new search topology in the given search service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Otherwise, an empty topology is created. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -39,8 +37,7 @@ New-SPEnterpriseSearchTopology -SearchApplication $ssa This example creates a new, empty search topology in the search service application referenced by $ssa. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa @@ -49,10 +46,12 @@ New-SPEnterpriseSearchTopology -SearchApplication $ssa -Clone -SearchTopology $t This example creates a new search topology in the search service application referenced by $ssa by cloning the existing topology referenced by $topology. - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which the search topology will belong. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -60,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,14 +69,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,13 +88,15 @@ Accept wildcard characters: False ``` ### -Clone + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new search topology is to be created by cloning an existing search topology. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +106,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new search topology is to be created by cloning an existing search topology. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,13 +124,15 @@ Accept wildcard characters: False ``` ### -SearchTopology + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing search topology of which the new topology will be a clone. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPLogFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPLogFile.md index 93bbaafef..4cc533399 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPLogFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPLogFile.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new log file. - ## SYNTAX ``` @@ -24,20 +23,21 @@ The `New-SPLogFile` cmdlet ends the current log file and starts a new log file. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPLogFile ``` This example ends the current log file and starts a new log file. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +49,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedAccount.md index 6acb9262d..f2da3bf55 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedAccount.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Registers a new managed account. - ## SYNTAX ``` @@ -20,16 +19,14 @@ New-SPManagedAccount [-Credential] [-AssignmentCollection ] ``` - ## DESCRIPTION The `New-SPManagedAccount` cmdlet registers a new managed account for the specified Credential or Username and Password. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $cred = Get-Credential New-SPManagedAccount -Credential $cred @@ -37,18 +34,19 @@ New-SPManagedAccount -Credential $cred This example adds a new managed account to the farm by using credentials that are prompted. - ## PARAMETERS ### -Credential + +> Applicable: SharePoint Server Subscription Edition + Indicates the Credential object that specifies the credentials of the new managed account. If you use Credential, you cannot specify Username and Password. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,13 +80,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -103,7 +108,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedPath.md index fb36df090..b8fb47a16 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPManagedPath.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new managed path for the given Web application for all host header site collections. - ## SYNTAX ### HostHeader @@ -40,20 +39,21 @@ If the Explicit parameter is not provided, the new managed path is a wildcard pa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPManagedPath "Teams" -WebApplication "https://somesite" ``` This example creates a Teams managed path for a given Web application (https://somesite). - ## PARAMETERS ### -RelativeURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the relative URL for the new managed path. The type must be a valid partial URL such as site or sites/teams/. @@ -61,8 +61,7 @@ The type must be a valid partial URL such as site or sites/teams/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -72,13 +71,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + If this parameter is provided, this managed path applies to all host header site collections. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application group to add this path. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-5678-0987645a. @@ -95,8 +99,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -117,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -Explicit + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the managed path is explicit or wildcard. If not provided, the managed path is a wildcard path. @@ -152,8 +162,7 @@ If not provided, the managed path is a wildcard path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -170,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMarketplaceWebServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMarketplaceWebServiceApplicationProxy.md index 8b7947b60..0d0d63799 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMarketplaceWebServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMarketplaceWebServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a service application proxy for the app identity data web service. - ## SYNTAX ``` @@ -26,27 +25,27 @@ Use the `New-SPMarketplaceWebServiceApplicationProxy` cmdlet to create a service For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPMarketplaceWebServiceApplicationProxy -Name ApplicationIdentityData -ServiceEndpointUri http://server:7800/ApplicationIdentityData.svc -DefaultProxyGroup ``` This example adds a proxy named ApplicationIdentityData to the app identity web service. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -ServiceEndpointUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the app identity data web service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +87,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,13 +116,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to add the service application proxy to the default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplication.md index aad066319..095114c56 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new managed metadata service application. - ## SYNTAX ### NoQuota @@ -43,18 +42,16 @@ Use the `New-SPMetadataServiceApplication` cmdlet to create a new managed metada For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell New-SPMetadataServiceApplication -Name "MetadataServiceApp1" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB1" ``` This example creates a new managed metadata service application. - -### -------------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell New-SPMetadataServiceApplication -Name "MetadataServiceApp2" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB2" -HubUri "https://sitename" -SyndicationErrorReportEnabled ``` @@ -62,26 +59,26 @@ New-SPMetadataServiceApplication -Name "MetadataServiceApp2" -ApplicationPool "A This example creates a new managed metadata service application and specifies a content type hub to be used for syndication. It also enables error reporting during syndication. - -### -------------------EXAMPLE 3------------- +### EXAMPLE 3 ```powershell New-SPMetadataServiceApplication -Name "MetadataServiceApp3" -ApplicationPool "AppPool1" -DatabaseName "MetadataDB3" -PartitionMode ``` This example creates a new managed metadata service application that is partitioned, for use by sites in a subscription. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application to create. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,14 +88,16 @@ Accept wildcard characters: False ``` ### -AdministratorAccount + +> Applicable: SharePoint Server Subscription Edition + A comma-separated list of user accounts or service accounts in the format \\\\ that may create and run the service application. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +107,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies an existing IIS application pool in which to run the new managed metadata service application. The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool, or an instance of an SPServiceApplicationPool object. @@ -115,8 +117,7 @@ The value must be a GUID that is the identity of an SPServiceApplicationPool obj ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -126,6 +127,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -137,8 +141,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +151,9 @@ Accept wildcard characters: False ``` ### -CacheTimeCheckInterval + +> Applicable: SharePoint Server Subscription Edition + Specifies an interval, in seconds, that a front-end Web Server should wait before asking the application server for changes. This value is set per timer job, client application, or Web application. @@ -157,8 +163,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,6 +173,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -175,7 +183,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -185,6 +192,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If SQL authentication is to be used, either DatabaseCredentials must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. @@ -194,8 +204,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,6 +214,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the new managed metadata service application. The type must be a valid name of a SQL Server database; for example MeatadataDB1. @@ -212,8 +224,7 @@ The type must be a valid name of a SQL Server database; for example MeatadataDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -223,6 +234,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid name of a SQL Server database; for example SqlServerHost1. @@ -230,8 +244,7 @@ The type must be a valid name of a SQL Server database; for example SqlServerHos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -241,6 +254,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -248,8 +264,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -259,14 +274,16 @@ Accept wildcard characters: False ``` ### -FullAccessAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read/write permission to the managed metadata service's term store and content type gallery. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -276,13 +293,15 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -292,6 +311,9 @@ Accept wildcard characters: False ``` ### -MaxChannelCache + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server should hold open to the application server. This value is set per timer job, client application, or Web application. @@ -301,8 +323,7 @@ The minimum value is 0, and there is no maximum value. The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -312,6 +333,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restrict data by subscription. Note This property cannot be changed after the service application has been created. @@ -321,8 +345,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -332,6 +355,9 @@ Accept wildcard characters: False ``` ### -ReadAccessAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read-only permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -339,8 +365,7 @@ The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -350,15 +375,17 @@ Accept wildcard characters: False ``` ### -RestrictedAccount -Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery; and permission to write to open term sets and local term sets and to create new enterprise keywords. + +> Applicable: SharePoint Server Subscription Edition + +Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery; and permission to write to open term sets and local term sets and to create new enterprise keywords. The accounts must already exist. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -368,13 +395,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables reporting of errors when content types are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -384,6 +413,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -391,7 +423,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -401,13 +432,15 @@ Accept wildcard characters: False ``` ### -DisablePartitionQuota + +> Applicable: SharePoint Server Subscription Edition + Disables partition quotas. ```yaml Type: SwitchParameter Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -417,13 +450,15 @@ Accept wildcard characters: False ``` ### -GroupsPerPartition + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of Term Groups per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -433,13 +468,15 @@ Accept wildcard characters: False ``` ### -LabelsPerPartition + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of Labels per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -449,13 +486,15 @@ Accept wildcard characters: False ``` ### -PropertiesPerPartition + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of Properties per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -465,13 +504,15 @@ Accept wildcard characters: False ``` ### -TermSetsPerPartition + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of Term Sets per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -481,12 +522,14 @@ Accept wildcard characters: False ``` ### -TermsPerPartition + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of Terms per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -496,13 +539,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplicationProxy.md index d885b8d2f..009431991 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPMetadataServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new connection to a managed metadata service application. - ## SYNTAX ``` @@ -22,42 +21,40 @@ New-SPMetadataServiceApplicationProxy -Name [-AssignmentCollection ] [-Uri ] [-WhatIf] [] ``` - ## DESCRIPTION Use the `New-SPMetadataServiceApplicationProxy` cmdlet to create a new connection to a managed metadata service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------- +### EXAMPLE 1 ```powershell New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy1" -ServiceApplication "MetadataServiceApp1" ``` This example creates a connection to a managed metadata service application in the local farm. - -### -------------------EXAMPLE 2---------------- +### EXAMPLE 2 ```powershell New-SPMetadataServiceApplicationProxy -Name "MetadataServiceProxy3" -ServiceApplication "MetadataServiceApp3" -PartitionMode ``` This example creates a partitioned connection to a managed metadata service application in the local farm. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the service application proxy to create. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,13 +107,15 @@ Accept wildcard characters: False ``` ### -ContentTypePushdownEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that existing instances of changed content types in subsites and libraries will be updated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -ContentTypeSyndicationEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,13 +143,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the connection be added to the default proxy group for the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,13 +161,15 @@ Accept wildcard characters: False ``` ### -DefaultKeywordTaxonomy + +> Applicable: SharePoint Server Subscription Edition + Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,13 +179,15 @@ Accept wildcard characters: False ``` ### -DefaultSiteCollectionTaxonomy + +> Applicable: SharePoint Server Subscription Edition + Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restrict data by subscription. This property cannot be changed after the service application proxy has been created. @@ -193,8 +207,7 @@ This property cannot be changed after the service application proxy has been cre ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,6 +217,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the local managed metadata service application to connect to. The service application must exist on the local farm. @@ -212,8 +228,7 @@ The type must be a valid GUID; a valid name of the service application; or an in ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -223,6 +238,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of a remote managed metadata service application to connect to. To specify the managed metadata service application that this proxy is connecting to, you must set only the URI parameter or only the ServiceApplication parameter. @@ -232,8 +250,7 @@ The type must be a valid URL, in the form urn:schemas-microsoft-com:sharepoint:s ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,6 +260,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -250,7 +270,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPODataConnectionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPODataConnectionSetting.md index e2777989f..9900bb105 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPODataConnectionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPODataConnectionSetting.md @@ -25,7 +25,7 @@ New-SPODataConnectionSetting -ServiceContext -Name -Name Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMode + +> Applicable: SharePoint Server Subscription Edition + {{ Fill AuthenticationMode Description }} ```yaml Type: ODataAuthenticationMode Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Accepted values: PassThrough, RevertToSelf, Credentials, WindowsCredentials, DigestCredentials, ClientCertificate, Anonymous Required: True @@ -74,13 +79,15 @@ Accept wildcard characters: False ``` ### -ExtensionProvider + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ExtensionProvider Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,13 +97,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Name Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -106,13 +115,15 @@ Accept wildcard characters: False ``` ### -SecureStoreTargetApplicationId + +> Applicable: SharePoint Server Subscription Edition + {{ Fill SecureStoreTargetApplicationId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,13 +133,15 @@ Accept wildcard characters: False ``` ### -ServiceAddressURL + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceAddressURL Description }} ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -138,13 +151,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceContext Description }} ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md index 96469ae8b..a29ffe44d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md @@ -25,7 +25,7 @@ New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -Name ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell {{ Add example code here }} ``` @@ -35,6 +35,9 @@ New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -Name ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + {{ Fill DefaultProxyGroup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,13 +77,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Name Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -89,13 +95,15 @@ Accept wildcard characters: False ``` ### -OnlineTenantUri + +> Applicable: SharePoint Server Subscription Edition + {{ Fill OnlineTenantUri Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -105,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -121,6 +131,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -128,7 +141,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplication.md index 3c0ec9bb0..e5581838d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a PowerPoint Conversion Service application. - ## SYNTAX ``` @@ -21,7 +20,6 @@ New-SPPowerPointConversionServiceApplication [-Name] [-Confirm] [-WhatIf] [] ``` - ## DESCRIPTION Use the `New-SPPowerPointConversionServiceApplication` cmdlet to create a new instance of a PowerPoint Conversion Service application by using the Name parameter. @@ -29,7 +27,6 @@ After the PowerPoint Conversion Service application is created, you can convert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES ### Example @@ -39,17 +36,18 @@ New-SPPowerPointConversionServiceApplication -Name "PowerPoint Conversion Servic This example creates a new instance of the PowerPoint Conversion Service application named _PowerPoint Conversion Service Application_ and assigns it to the default application pool. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the PowerPoint Conversion Service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,13 +57,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Assigns an application pool that Internet Information Services (IIS) will use for this service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplicationProxy.md index bc548a36a..36c2f5ce9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPPowerPointConversionServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a PowerPoint Conversion Service application proxy. - ## SYNTAX ``` @@ -25,7 +24,6 @@ New-SPPowerPointConversionServiceApplicationProxy [-Name] Use the `New-SPPowerPointConversionServiceApplicationProxy` cmdlet to create a PowerPoint Conversion Service application proxy. The service application proxy is instantiated on the front-end web server and acts as an intermediary between the client computer and the service application back end. - ## EXAMPLES ### Example @@ -35,17 +33,18 @@ New-SPPowerPointConversionServiceApplicationProxy -Name "PowerPoint Conversion S This example creates a new instance of the PowerPoint Conversion Service application proxy named _PowerPoint Conversion Service application proxy_, binds it to the _PowerPoint Conversion Service Application_ service application, and then adds it to the default service application proxy group - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,13 +54,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service application to bind. ```yaml Type: SPPowerPointConversionServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,14 +72,16 @@ Accept wildcard characters: False ``` ### -AddToDefaultGroup + +> Applicable: SharePoint Server Subscription Edition + Adds the newly created proxy to the default service application proxy group. If not specified, the proxy is not added to a group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +105,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplication.md index 8eed90cdf..40e8159da 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a User Profile Service Application to a farm. - ## SYNTAX ### Default @@ -48,20 +47,21 @@ The `New-SPProfileServiceApplication` cmdlet adds and creates a new profile serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync ``` This example creates a new User Profile Service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -69,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +79,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name for the new User Profile Service application. The name must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 64 characters. @@ -89,8 +91,7 @@ The type must be a valid name of a service application; for example, UserProfile ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +115,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -139,15 +144,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the My Site will be created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -156,20 +163,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +### -MySiteManagedPath -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -MySiteManagedPath Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -177,8 +174,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,6 +184,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. @@ -196,8 +195,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -207,6 +205,9 @@ Accept wildcard characters: False ``` ### -ProfileDBCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. The type must be a valid PSCredential object. @@ -214,8 +215,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -225,13 +225,15 @@ Accept wildcard characters: False ``` ### -ProfileDBName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database where the User Profile database is created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -241,6 +243,9 @@ Accept wildcard characters: False ``` ### -ProfileDBServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database where the User Profile database will be created. The type must be a valid name of a SQL Server database; for example, ProfileAppDB1. @@ -248,8 +253,7 @@ The type must be a valid name of a SQL Server database; for example, ProfileAppD ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -259,6 +263,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid PSCredential object. @@ -266,8 +273,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -277,14 +283,16 @@ Accept wildcard characters: False ``` ### -ProfileDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Associates a content database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -294,6 +302,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBName + +> Applicable: SharePoint Server Subscription Edition + Specifies the database where the Profile Sync database will be created. The type must be a valid name of a SQL Server database; for example, ProfileSyncAppDB1. @@ -301,8 +312,7 @@ The type must be a valid name of a SQL Server database; for example, ProfileSync ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -312,6 +322,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server that will host the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid name of a SQL Server host; for example, SQLServerProfileSyncHost1. @@ -319,8 +332,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerProfil ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -330,14 +342,16 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Associates a Profile Sync database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -347,6 +361,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -365,8 +382,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -376,6 +392,9 @@ Accept wildcard characters: False ``` ### -SocialDBCredentials + +> Applicable: SharePoint Server Subscription Edition + The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. The type must be a valid PSCredential object. @@ -383,8 +402,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -394,6 +412,9 @@ Accept wildcard characters: False ``` ### -SocialDBName + +> Applicable: SharePoint Server Subscription Edition + Specifies the database where the Social database will be created. The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. @@ -401,8 +422,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerSocial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -412,6 +432,9 @@ Accept wildcard characters: False ``` ### -SocialDBServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server that will host the Social database that is specified in SocialDBName. The type must be a valid name of a SQL Server host; for example, SQLServerSocialHost1. @@ -419,8 +442,7 @@ The type must be a valid name of a SQL Server host; for example, SQLServerSocial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -430,14 +452,16 @@ Accept wildcard characters: False ``` ### -SocialDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Associates a Social database with a specific failover server that is used in conjunction with SQL Server database mirroring. The server name is the required value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -447,6 +471,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -454,7 +481,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -464,13 +490,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplicationProxy.md index 3c8e8610e..bc50d03c7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProfileServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a User Profile Service application proxy on the local farm. - ## SYNTAX ### Application @@ -38,10 +37,9 @@ The proxy is added to the default proxy group for the local farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $sa = New-SPProfileServiceApplication -Name 'User Profile Service Application' -ApplicationPool 'SharePoint Web Services Default' -ProfileDBName Profile -SocialDBName Social -ProfileSyncDBname Sync New-SPProfileServiceApplicationProxy -Name 'User Profile Service Application Proxy' -ServiceApplication $sa -DefaultProxyGroup @@ -49,10 +47,12 @@ New-SPProfileServiceApplicationProxy -Name 'User Profile Service Application Pro This example creates a new User Profile Service application proxy. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the local User Profile Service application that is associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription User Profile Service application (for example, ProfileSvcApp1); or an instance of a valid SPServiceApplication object. @@ -60,8 +60,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: Application -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,14 +70,16 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + The URI of the remote user profile service application this proxy should communicate with. This value is required only if you plan to connect a User Profile Service application from a remote farm. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,13 +132,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the User Profile Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +150,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name for the new User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -152,8 +162,7 @@ The type must be a name of a valid User Profile Service application proxy; for e ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,14 +172,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplication.md index bcdff33ed..9c6673154 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplication.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/new-spprojectserviceapplication -Applicable: SharePoint Server Subscription Edition + title: New-SPProjectServiceApplication schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Project Server Service application. - ## SYNTAX ``` @@ -25,18 +24,16 @@ The `New-SPProjectServiceApplication` cmdlet creates a new Project Server Servic For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPProjectServiceApplication -Name "PsiApplication" -ApplicationPool "PsiApplicationPool" -Proxy ``` This example creates a Project Server Service application with the name PsiApplication and an application pool with the name PsiApplicationPool and it creates a Project Server Service application proxy for the application. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPIisWebServiceApplicationPool "PsiApplicationPool" | New-SPProjectServiceApplication -Name "PsiApplication" ``` @@ -44,10 +41,12 @@ Get-SPIisWebServiceApplicationPool "PsiApplicationPool" | New-SPProjectServiceAp This example creates a Project Server Service application with the name PsiApplication. The result is piped using an application pool object. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool to run the Web service in for the new service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -55,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new Project Server Service application. The type must be a valid name of a Project Server Service application; for example, ProjectWebApp1. @@ -73,8 +74,7 @@ The type must be a valid name of a Project Server Service application; for examp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -84,6 +84,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +98,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,13 +108,15 @@ Accept wildcard characters: False ``` ### -Proxy + +> Applicable: SharePoint Server Subscription Edition + Specifies that a proxy for new service application is automatically created. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplicationProxy.md index bbae39381..8e979c2e4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPProjectServiceApplicationProxy.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/new-spprojectserviceapplicationproxy -Applicable: SharePoint Server Subscription Edition + title: New-SPProjectServiceApplicationProxy schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a proxy for a Project Server Service application. - ## SYNTAX ``` @@ -25,28 +24,28 @@ The `New-SPProjectServiceApplicationProxy` cmdlet creates a proxy for a Project For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### -------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell New-SPProjectServiceApplicationProxy -Name PsiApplicationProxy -ServiceApplication PsiApplication ``` This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication. - -### -------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPServiceApplication | ?{ $_.Name -eq "PsiApplication" } | New-SPProjectServiceApplicationProxy -Name "PsiApplicationProxy" -Default ``` This example creates a Project Server Service application proxy with the name PsiApplicationProxy for the application PsiApplication and adds the proxy to the Default proxy group. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new proxy. The type must be a valid name of a Project Server Service application proxy; for example, ProjectSvcProxy1. @@ -54,8 +53,7 @@ The type must be a valid name of a Project Server Service application proxy; for ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -65,6 +63,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Project Server Service application to associate with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -73,7 +74,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -83,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +97,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPRequestManagementRuleCriteria.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPRequestManagementRuleCriteria.md index 909d26bcc..a75d0b9cf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPRequestManagementRuleCriteria.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPRequestManagementRuleCriteria.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates criteria for the rule to match. - ## SYNTAX ### CustomPropertyParameterSet @@ -36,10 +35,9 @@ For more information about how to use parameter sets, see [Cmdlet parameter sets Use the `New-SPRequestManagementRuleCriteria` cmdlet to create criteria for the rule to match. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPRequestManagementRuleCriteria -Property Host -Value Client01 -MatchType Equals ``` @@ -49,13 +47,15 @@ This example creates a new rule that matches the Host 'Client01'. ## PARAMETERS ### -Value + +> Applicable: SharePoint Server Subscription Edition + Specifies a value for the rule to match. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -65,13 +65,15 @@ Accept wildcard characters: False ``` ### -CustomHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom header for the rule. ```yaml Type: String Parameter Sets: CustomPropertyParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Property + +> Applicable: SharePoint Server Subscription Edition + Specifies a header for a value to match. The following are the valid values: @@ -104,8 +109,7 @@ The following are the valid values: ```yaml Type: SPRequestManagementRulePropertyType Parameter Sets: StandardParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -115,13 +119,15 @@ Accept wildcard characters: False ``` ### -CaseSensitive + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not the match is case sensitive. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -131,6 +137,9 @@ Accept wildcard characters: False ``` ### -MatchType + +> Applicable: SharePoint Server Subscription Edition + Defines operators for the match. The following are the valid values: @@ -146,8 +155,7 @@ The following are the valid values: ```yaml Type: SPRequestManagementRuleMatchType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -157,6 +165,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -168,8 +179,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplication.md index 43d3fd8c9..91cda3c29 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Secure Store application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The `New-SPSecureStoreApplication` cmdlet creates a new Secure Store application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $usernameField = New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false $passwordField = New-SPSecureStoreApplicationField -Name "Password" -Type WindowsPassword -Masked:$true @@ -42,17 +40,18 @@ New-SPSecureStoreApplication -ServiceContext http://contoso -TargetApplication $ This example creates a new group target application ContosoTargetApplication and then a new application for that target application. This new application has two fields; UserName of type WindowsUserName and Password of type WindowsPassword. The user with identity janedoe on the CONTOSO domain is set as the target application administrator. - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for the target application. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -TargetApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies information about the target application. For example, the TargetApplication object includes data values for application name, display name, contact info, enable ticketing flag and URL address to set the credential. The schema for the TargetApplication object is defined in the ISecureSToreProviderExtended interface that exposes the target application metadata. @@ -69,8 +71,7 @@ The schema for the TargetApplication object is defined in the ISecureSToreProvid ```yaml Type: TargetApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -Administrator + +> Applicable: SharePoint Server Subscription Edition + Specifies the administrator of the new Secure Store application. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -CredentialsOwnerGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the claims object for the groups that own the group credentials. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,14 +141,16 @@ Accept wildcard characters: False ``` ### -Fields + +> Applicable: SharePoint Server Subscription Edition + Specifies the field information for the application. The default fields are username and password. ```yaml Type: TargetApplicationField[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -TicketRedeemer + +> Applicable: SharePoint Server Subscription Edition + Specifies the ticket redeemer claim value. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplicationField.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplicationField.md index 42a0b54bd..19f02abd9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplicationField.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreApplicationField.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Secure Store application fields object. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `New-SPSecureStoreApplicationField` cmdlet creates a new Secure Store applic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked:$false ``` @@ -36,17 +34,18 @@ New-SPSecureStoreApplicationField -Name "UserName" -Type WindowsUserName -Masked This example creates a new credential field of type WindowsUserName with the name UserName and the masked property (which when true will hide characters as they are typed in by the user) set to false. This cmdlet is typically used in conjunction with the `New-SPSecureStoreApplication` cmdlet. - ## PARAMETERS ### -Masked + +> Applicable: SharePoint Server Subscription Edition + Masks the visible characters that are typed in the field. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new target application field. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of credential field to add to a target application. The type must be one of the following: UserName, Password, Pin, Key, Generic, WindowsUserName, or WindowsPassword. @@ -79,8 +83,7 @@ The type must be one of the following: UserName, Password, Pin, Key, Generic, Wi ```yaml Type: SecureStoreCredentialType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +107,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplication.md index 6407d5097..b40722cbb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Secure Store Service application in the farm. - ## SYNTAX ``` @@ -29,27 +28,27 @@ The `New-SPSecureStoreServiceApplication` cmdlet creates a new Secure Store Serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' ``` This example creates a new Secure Store Service application with the name Contoso Secure Store with auditing disabled and creates a database with the name ContosoSSDatabase on the given database server for use with the service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool to run the Web service in for the new service application. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -AuditingEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on auditing for the Secure Store Service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,13 +76,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new Secure Store Service application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +108,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -AuditlogMaxSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days to retain the audit log. The type must be a valid integer. @@ -120,8 +128,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,14 +193,16 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,13 +212,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -213,14 +230,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -230,13 +249,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -246,6 +267,9 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. @@ -254,8 +278,7 @@ This property has no effect on SharePoint Server 2019. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -265,13 +288,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Store service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -281,6 +306,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -288,7 +316,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -298,13 +325,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplicationProxy.md index a4faf1c14..ef0904292 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Secure Store Service application proxy in the farm. - ## SYNTAX ### PipeBind @@ -43,10 +42,9 @@ The result of the `New-SPSecureStoreServiceApplication` cmdlet can be passed to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $sa = New-SPSecureStoreServiceApplication -ApplicationPool 'SharePoint Web Services Default' -AuditingEnabled:$false -DatabaseName 'Secure Store' -Name 'Secure Store Service Application' New-SPSecureStoreServiceApplicationProxy -Name 'Secure Store Service Application Proxy' -ServiceApplication $sa @@ -54,8 +52,7 @@ New-SPSecureStoreServiceApplicationProxy -Name 'Secure Store Service Application This example creates a new Secure Store Service application and proxy. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $nameofproxy = "Connection to: HostedSecureStoreInParentFarm" $proxy = Get-SPServiceApplicationProxy | where {$_ -match $nameofproxy} @@ -68,17 +65,18 @@ $proxy.Update() This example converts an unpartitioned secure store service application proxy in the child to a partitioned one. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the local Secure Store Service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: PipeBind -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +86,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of a remote Secure Store Service application associated with the new proxy. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -95,8 +96,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -117,8 +120,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -145,13 +149,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application proxy be added to the farm's default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,13 +167,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new service application proxy to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,6 +185,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -184,7 +195,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreTargetApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreTargetApplication.md index cfca8f620..c381ed778 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreTargetApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSecureStoreTargetApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Secure Store target application. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `New-SPSecureStoreTargetApplication` cmdlet creates a new Secure Store Targe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell New-SPSecureStoreTargetApplication -Name "ContosoTargetApplication" -FriendlyName "Contoso Target Application" -ApplicationType Group ``` This example creates a new group type target application with the given name and friendly display name. - ## PARAMETERS ### -ApplicationType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of target application. The type must be one of the following: Individual, Group, IndividualWithTicketing, GroupWithTicketing, RestrictedIndividual, or RestrictedGroup. @@ -47,8 +47,7 @@ The type must be one of the following: Individual, Group, IndividualWithTicketin ```yaml Type: TargetApplicationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the new target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -101,8 +107,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -ContactEmail + +> Applicable: SharePoint Server Subscription Edition + Specifies the contact information for the target application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -SetCredentialsUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI for setting the user application credentials. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -135,8 +145,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +155,9 @@ Accept wildcard characters: False ``` ### -TimeoutInMinutes + +> Applicable: SharePoint Server Subscription Edition + The time, in minutes, a ticket is valid if it is not redeemed by the target application. Make sure that the ticket time-out value is long enough to last between the time when the ticket is issued to the time that it is redeemed The default value is 2. @@ -154,8 +166,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationPool.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationPool.md index 2bb412632..582366464 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationPool.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Web service application pool. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `New-SPServiceApplicationPool` cmdlet creates a new Web service application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPServiceApplicationPool -Name 'SharePoint Web Services Default' -Account (Get-SPManagedAccount 'contoso\serviceAccount') ``` @@ -39,17 +37,18 @@ For the Account parameter, the name of a managed account in the farm can be give Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new Web service application pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -Account + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials that will be the identity of the new application pool. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationProxyGroup.md index 802d58efe..fa9212884 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPServiceApplicationProxyGroup.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new service application proxy group. - ## SYNTAX ``` @@ -25,27 +24,27 @@ The `New-SPServiceApplicationProxyGroup` cmdlet creates a new service applicatio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPServiceApplicationProxyGroup -Name RemoteProxyGroup ``` This example creates a new service application proxy with the name RemoteProxyGroup. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new service application proxy group. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSite.md index fe3a35f0a..f9d4dbcd5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new site collection at the specified URL. - ## SYNTAX ``` @@ -32,18 +31,16 @@ This cmdlet can create site collections in either the SharePoint Server mode whi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPSite https://webApp/sites/test -OwnerAlias "DOMAIN\JDoe" -Language 1033 -Template STS#0 ``` This example creates an English site collection at https://\/sites/test that is owned by user DOMAIN\Jdow. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell $w = Get-SPWebApplication https://webApp New-SPSite https://www.contoso.com -OwnerAlias "DOMAIN\jdow" -HostHeaderWebApplication $w -Name "Contoso" -Template STS#0 @@ -52,26 +49,26 @@ New-SPSite https://www.contoso.com -OwnerAlias "DOMAIN\jdow" -HostHeaderWebAppli This example creates a host-named site collection. Because the template is provided, the root web of this site collection will be created. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell Get-SPWebTemplate | Where{ $_.Title -eq "Team Site" } | ForEach-Object{ New-SPSite https:///sites/testsite that is owned by user DOMAIN\Jdow - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL that the new site collection uses. If the URL is not a host header site, the URL must start with the web application URL. @@ -79,8 +76,7 @@ If the URL is not a host header site, the URL must start with the web applicatio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -90,6 +86,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Specifies the user login name of the site owner. The type must be a valid user alias, in the form, Domain\username. @@ -97,8 +96,7 @@ The type must be a valid user alias, in the form, Domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -108,6 +106,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server Subscription Edition + Specifies the site type. Valid values are None or TentantAdministration. @@ -115,8 +116,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,6 +126,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -137,8 +140,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,18 +150,19 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +172,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +182,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -186,6 +191,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or GUID of the content database in which to create the new site. If no content database is specified, the site collection is selected automatically. The type must be a valid database name in the form, SiteContent1212, or a GUID in the form, 1234-5678-9807. @@ -193,8 +201,7 @@ The type must be a valid database name in the form, SiteContent1212, or a GUID i ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,6 +211,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Describes the new site. If no value is specified, the value is left blank. @@ -211,8 +221,7 @@ If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -222,6 +231,9 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies that if the URL provided is to be a host-named site collection, the HostHeaderWebApplication parameter must be the name, URL, GUID, or SPWebApplication object for the web application in which this site collection is created. If no value is specified, the value is left blank. @@ -234,12 +246,10 @@ The type must be a valid name in one of the following forms: --A GUID (for example, 1234-5678-9876-0987) - ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -249,6 +259,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the language ID for the new site collection. If no language is specified, the site collection is created with the same language that was specified when the product was installed. @@ -258,8 +271,7 @@ This must be a valid language identifier (LCID). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -269,6 +281,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the title of the new site collection. If no name is specified, the default name is applied. @@ -276,8 +291,7 @@ If no name is specified, the default name is applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -287,6 +301,9 @@ Accept wildcard characters: False ``` ### -OverrideCompatibilityRestriction + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to use compatibility restriction for site. The valid values are True or False. @@ -294,8 +311,7 @@ The valid values are True or False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -305,6 +321,9 @@ Accept wildcard characters: False ``` ### -OwnerEmail + +> Applicable: SharePoint Server Subscription Edition + Specifies the email address of site owner. If no value is specified, the value is left blank. @@ -313,8 +332,7 @@ The type must be a email address in the form, someone@example.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -324,6 +342,9 @@ Accept wildcard characters: False ``` ### -QuotaTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies the quota template for the new site.The template must exist already. If no template is specified, no quota is applied. @@ -331,8 +352,7 @@ If no template is specified, no quota is applied. ```yaml Type: SPQuotaTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -342,6 +362,9 @@ Accept wildcard characters: False ``` ### -SecondaryEmail + +> Applicable: SharePoint Server Subscription Edition + Specifies the email address of the secondary site owner. If no value is specified, the value is left blank. The type must be a email address, in the form, someone@example.com. @@ -349,8 +372,7 @@ The type must be a email address, in the form, someone@example.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -360,6 +382,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Specifies the user login credentials of the secondary site owner. If no value is specified, the value is left blank. @@ -369,8 +394,7 @@ The type must be a valid user alias, in the form, Domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -380,13 +404,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -396,6 +422,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web template for the root web of the new site collection. The template must be already installed. @@ -405,8 +434,7 @@ If no template is specified, no template is provisioned. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -416,6 +444,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -423,7 +454,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -433,6 +463,9 @@ Accept wildcard characters: False ``` ### -CreateFromSiteMaster + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to create a new site using the Site Master. The valid values are True or False. @@ -440,8 +473,7 @@ The valid values are True or False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteMaster.md index ec4d1c8f0..ba8111233 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/new-spsitemaster -Applicable: SharePoint Server Subscription Edition + title: New-SPSiteMaster schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a site master. - ## SYNTAX ``` @@ -24,20 +23,21 @@ New-SPSiteMaster [-ContentDatabase] ## DESCRIPTION Use the New-SPSiteMaster cmdlet to create a site master information in the farm. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPSiteMaster -ContentDatabase WSS_Content -Template STS#0 ``` This example creates a site master in the database WSS_Content. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -45,8 +45,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the SiteCreationMode setting. @@ -63,8 +65,7 @@ When this parameter is not specified, the CompatibilityLevel will default to the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create the site master in. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the locale ID to use. For example, use 1033 for English. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the template. The values are the following: @@ -143,8 +153,7 @@ The values are the following: ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -161,7 +173,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscription.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscription.md index 371e32431..38affcb46 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscription.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscription.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new site subscription. - ## SYNTAX ``` @@ -20,7 +19,7 @@ New-SPSiteSubscription [-AssignmentCollection ] [ Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscriptionFeaturePack.md index e4949fc1d..43dd7b04e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSiteSubscriptionFeaturePack.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new SharePoint Feature set that can be used to limit the features available to a site subscription. - ## SYNTAX ``` @@ -29,10 +28,9 @@ Feature sets contain a list of the GUIDs of each Feature that is on an Allow Lis For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $fs = New-SPSiteSubscriptionFeaturePack @@ -41,10 +39,12 @@ $fs = New-SPSiteSubscriptionFeaturePack This example creates a new SharePoint Feature Pack and stores it in a variable. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,8 +56,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -74,7 +76,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplication.md index 56c995e6d..0bbdf0519 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new state service application. - ## SYNTAX ``` @@ -26,10 +25,9 @@ A state service application is the container for state service databases. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell $db = New-SPStateServiceDatabase -Name 'StateSvcDB1' New-SPStateServiceApplication -Name 'State Service' -Database $db @@ -40,6 +38,9 @@ This example creates a new state service database and a state service applicatio ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new service application. The type must be a valid name of a service application; for example, StateSvcApp1. @@ -47,8 +48,7 @@ The type must be a valid name of a service application; for example, StateSvcApp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +82,9 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database that is associated with the new service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -87,8 +92,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPStateDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplicationProxy.md index a30f3416c..ebb86e3e4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a proxy for a state service application. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `New-SPStateServiceApplicationProxy` cmdlet creates a proxy for a state serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE------------------- +### EXAMPLE ```powershell $db = New-SPStateServiceDatabase -Name 'State Service' $sa = New-SPStateServiceApplication -Name 'State Service' -Database $db @@ -37,10 +35,12 @@ New-SPStateServiceApplicationProxy -Name 'State Service Proxy' -ServiceApplicati This example creates a State Service database and Service Application. It then associates a new State Service Proxy with the State Service application and adds it to the Default proxy group. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to associate with the new proxy. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -48,8 +48,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application proxy is added to the farm's default proxy group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the new proxy. The type must be a valid name of a SQL Server database; for example, SessionStateDB1. @@ -105,8 +111,7 @@ Service application proxy; for example, StateSvcAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceDatabase.md index cea7f82fa..986ed7735 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPStateServiceDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates and provisions a new state service database and installs the state database schema into it. - ## SYNTAX ``` @@ -27,10 +26,9 @@ This cmdlet installs the session state database schema in the state service data For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell New-SPStateServiceDatabase -Name 'State Service' ``` @@ -40,13 +38,15 @@ This example creates a new state service database. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name for the state service database that is stored in SQL Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -86,8 +91,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +101,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the state service database. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -104,8 +111,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,6 +121,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to add the state database to. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -122,8 +131,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,6 +141,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server Subscription Edition + Specifies the weight for the state database. The default value is 1. @@ -143,8 +154,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplication.md index 9f0d97066..26bf1f580 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new subscription settings service application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ This cmdlet is used only in an environment where site subscriptions are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE--------------- +### EXAMPLE ```powershell $sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' @@ -45,6 +43,9 @@ This example creates a Subscriptions Settings Service application. ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS application pool to use for the new subscription settings application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -52,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -63,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -102,6 +106,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -109,8 +116,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +126,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the subscription settings database. If not provided, one will be generated. @@ -129,8 +138,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,6 +148,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL Server instance for the database specified in the DatabaseName parameter. If not provided, the default database server will be used. @@ -150,8 +161,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,6 +171,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -168,8 +181,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,6 +191,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the friendly name of the new subscription settings service. The type must be a valid name of a subscription settings service application; for example, SubscriptionSettingsApp1. @@ -186,8 +201,7 @@ The type must be a valid name of a subscription settings service application; fo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,6 +211,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -204,7 +221,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -214,13 +230,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplicationProxy.md index 1415ecb73..1391b3e16 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPSubscriptionSettingsServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates an application proxy to a subscription settings service application. - ## SYNTAX ### ServiceApplication @@ -37,10 +36,9 @@ This is required for the local farm to consume a subscription settings service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------------- +### EXAMPLE ```powershell $sa = New-SPSubscriptionSettingsServiceApplication -ApplicationPool 'SharePoint Web Services Default' -Name 'Subscriptions Settings Service Application' -DatabaseName 'Subscription' New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $sa @@ -51,6 +49,9 @@ This example creates a new Subscription Settings Service application and proxy. ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the subscription settings service application associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -58,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: ServiceApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -69,6 +69,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the address of the subscription settings service application to associate the new application proxy with. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -76,8 +79,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: String Parameter Sets: Uri -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -126,6 +132,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -133,7 +142,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplication.md index 73d755d7b..01cf01d66 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Provisions a new instance of the Machine Translation service. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Use the `New-SPTranslationServiceApplication` cmdlet to provision a new instance For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE--------------- +### EXAMPLE ```powershell New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase ``` @@ -38,17 +36,18 @@ New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'S This example creates a Machine Translation service application named TranslationService which will run in the SharePoint Web Services Default service application pool. The database will be called TranslationServiceDatabase and will be hosted on the Server1 SQL server instance. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier of Translation Service instance to be created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed application pool that the instance of Translation Service will run in. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,14 +118,16 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the database name which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + Determines whether or not the proxy for this service application should be added to the default proxy group for this Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,13 +191,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,14 +209,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Restricts this service to behave uniquely on a partitioned set of site collections. This cannot be changed after the application is provisioned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -211,6 +228,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -218,7 +238,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -228,13 +247,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Specifies if the upgrade process is to be deferred and manually completed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplicationProxy.md index 62f426a28..97689c09d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTranslationServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a Machine Translation Service application proxy on the local farm. - ## SYNTAX ### ConnectLocal @@ -39,10 +38,9 @@ The proxy is added to the default proxy group for the local farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ```powershell $sa = New-SPTranslationServiceApplication -Name TranslationService -ApplicationPool 'SharePoint Web Services Default' -DatabaseServer Server1 -DatabaseName TranslationServiceDatabase New-SPTranslationServiceApplicationProxy -Name TranslationServiceProxy -ServiceApplication $sa -DefaultProxyGroup @@ -50,10 +48,12 @@ New-SPTranslationServiceApplicationProxy -Name TranslationServiceProxy -ServiceA This example creates a Machine Translation Service application and proxy in the default proxy group named TranslationServiceProxy. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name for the new Machine Translation Service application. The name that you use must be a unique name of a Machine Translation Service application in this farm. The name can be a maximum of 128 characters. @@ -61,8 +61,7 @@ The name can be a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +71,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the local Machine Translation Service application that is associated with the new proxy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Machine Translation Service application (for example, MachTrans1); or an instance of a valid SPServiceApplication object. @@ -79,8 +81,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: ConnectLocal -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,14 +91,16 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the remote machine translation service application this proxy should communicate with. This value is required only if you plan to connect a Machine Translation Service application from a remote farm. ```yaml Type: String Parameter Sets: ConnectRemote -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -118,8 +124,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,14 +171,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application restrict data by site group. After the PartitionMode parameter is set and the service application is created, it cannot be changed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,6 +190,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -186,7 +200,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedIdentityTokenIssuer.md index 0130e98d1..b9aa8938a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedIdentityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates an identity provider in the farm. - ## SYNTAX ### BasicParameterSet @@ -49,20 +48,21 @@ For security token service (STS) identity providers, this cmdlet creates and per For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ```powershell New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" - Description "LiveID STS" -Certificate (Get-ChildItem "cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") -SignInUrl https://int.contoso.com/ -IdentifierClaim "http://schemas.contoso.com/2007/05/Claims/Puid" ``` This example creates a new identity provider in the farm named LiveIDSTS. - ## PARAMETERS ### -ClaimsMappings + +> Applicable: SharePoint Server Subscription Edition + Specifies the mapping of the claims from the original token to the SharePoint token. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. @@ -70,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind[] Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,6 +80,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies a description for the new identity provider. The type must be a valid string; for example, LiveID STS. @@ -88,8 +90,7 @@ The type must be a valid string; for example, LiveID STS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +100,9 @@ Accept wildcard characters: False ``` ### -IdentifierClaim + +> Applicable: SharePoint Server Subscription Edition + Specifies which claim type from the trusted STS will be used for the new identity provider. The type must be a valid claim type from the trusted STS; for example, http://schemas.microsoft.com/2007/05/Claims/Puid. @@ -106,8 +110,7 @@ The type must be a valid claim type from the trusted STS; for example, http://sc ```yaml Type: String Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -117,6 +120,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new identity provider. The type must be a valid name of an identity provider; for example, LiveIDSTS. @@ -124,8 +130,7 @@ The type must be a valid name of an identity provider; for example, LiveIDSTS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -135,6 +140,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server Subscription Edition + Specifies the realm, or resource partition, associated with this trust. The type must be a name of a valid realm; for example, MD_REALM. @@ -142,8 +150,7 @@ The type must be a name of a valid realm; for example, MD_REALM. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -153,6 +160,9 @@ Accept wildcard characters: False ``` ### -SignInUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign-in URLs for this trusted STS identity provider. The type must be a valid URL, in the form https://int.live.com/. @@ -160,8 +170,7 @@ The type must be a valid URL, in the form https://int.live.com/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -171,6 +180,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -182,8 +194,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +204,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the IP STS that can resolve and search claims for claims people picker. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object. @@ -200,8 +214,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: BasicParameterSet, MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -211,6 +224,9 @@ Accept wildcard characters: False ``` ### -ImportTrustCertificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -218,8 +234,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -229,13 +244,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI for the metadata endpoint of the trusted provider. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -UseWReply + +> Applicable: SharePoint Server Subscription Edition + Includes a WReply with the token request. WReply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. @@ -252,8 +272,7 @@ WReply is a URL at the relying party to which the requestor is redirected once s ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -263,13 +282,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -279,6 +300,9 @@ Accept wildcard characters: False ``` ### -IdentifierClaimIs + +> Applicable: SharePoint Server Subscription Edition + Specifies which of the default mapped claims should be used as the identifier claim. Only used if the UseDefaultConfiguration parameter is set to true, otherwise use the IdentifierClaim parameter. @@ -286,8 +310,7 @@ Only used if the UseDefaultConfiguration parameter is set to true, otherwise use ```yaml Type: String Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -297,13 +320,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the Registered Issuer Name instead of not using the metadata endpoint. ```yaml Type: String Parameter Sets: BasicParameterSet, ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -313,13 +338,15 @@ Accept wildcard characters: False ``` ### -SignOutUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign out URI for the trusted provider. This lets SharePoint to sign the user out from the trusted provider when they sign out from SharePoint. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -329,6 +356,9 @@ Accept wildcard characters: False ``` ### -UseDefaultConfiguration + +> Applicable: SharePoint Server Subscription Edition + Specifies if the default set of claim mappings should be used. If UseDefaultConfiguration parameter is used, then the IdentifierClaimIs parameter must be used. @@ -336,8 +366,7 @@ If UseDefaultConfiguration parameter is used, then the IdentifierClaimIs paramet ```yaml Type: SwitchParameter Parameter Sets: ActiveDirectoryBackedParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -347,6 +376,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -354,7 +386,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedRootAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedRootAuthority.md index d1b512e26..bf0b92e3c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedRootAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a trusted root authority. - ## SYNTAX ### ManualUpdateCertificateParameterSet @@ -33,10 +32,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New-SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $cert @@ -44,10 +42,12 @@ New-SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $cert This example creates a new trusted root authority, WFEFarm1. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the trusted root authority to create. The value must be a valid name of a trusted root authority; for example, WFEFarm1. @@ -55,8 +55,7 @@ The value must be a valid name of a trusted root authority; for example, WFEFarm ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate of the trusted root authority. The value must be a name of a valid X.509 certificate; for example, Certificate1. @@ -73,8 +75,7 @@ The value must be a name of a valid X.509 certificate; for example, Certificate1 ```yaml Type: X509Certificate2 Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the Uri of the metadata endpoint. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -145,7 +155,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedSecurityTokenIssuer.md index 7bb679bf7..fce0e075c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedSecurityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a trust between a server to server principal. - ## SYNTAX ### ImportCertificateParameterSet @@ -38,27 +37,27 @@ Use the `New-SPTrustedSecurityTokenIssuer` cmdlet to establish a trust between a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE----------- +### EXAMPLE ```powershell New-SPTrustedSecurityTokenIssuer -Name "SPFarmA" -MetadataEndPoint https://mysite/my/_layouts/metadata/test/1/ -isSelfIssuer "false" ``` This example creates a new trusted security token named SPFarmA. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -68,13 +67,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI for the metadata endpoint of the issuer. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +117,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -129,7 +137,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -139,13 +146,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,13 +164,15 @@ Accept wildcard characters: False ``` ### -IsTrustBroker + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,13 +182,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the registered token issuer instead of using metadata endpoint. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -194,7 +210,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedServiceTokenIssuer.md index 0484b38a2..72fe00db5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPTrustedServiceTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a trust with a SharePoint farm. - ## SYNTAX ### ImportCertificateParameterSet @@ -34,10 +33,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Certificate $cert @@ -45,10 +43,12 @@ New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Cert This example shows how to create a new SharePoint Farm trust using the trust certificate from a file. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the trust. The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1. @@ -56,8 +56,7 @@ The type must be a valid name of a trusted service issuer; for example, WFEFarmT ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + The type must be a name of a valid X.509 certificate; for example, Certificate1. Specifies the X.509 certificate object from trusted authentication provider farm. @@ -74,8 +76,7 @@ Specifies the X.509 certificate object from trusted authentication provider farm ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. @@ -114,8 +120,7 @@ The type must be a valid string; for example, WFE Farm Trust1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,13 +130,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,13 +148,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI for the metadata endpoint of the trusted provider. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -157,6 +166,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +176,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageApplication.md index 4efd03fee..8cadc50ef 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new usage application. - ## SYNTAX ``` @@ -27,20 +26,21 @@ The `New-SPUsageApplication` cmdlet creates a new usage application in the local For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------- +### EXAMPLE ```powershell New-SPUsageApplication -Name "Usage Application For Farm ABC" ``` This example creates a new usage application for the specified name. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the friendly name of the new usage application. The type must be a valid name of a usage application; for example, UsageApplication1. @@ -48,8 +48,7 @@ The type must be a valid name of a usage application; for example, UsageApplicat ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the logging database. If the logging database does not exist, a logging database is automatically created. @@ -106,8 +112,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -125,8 +133,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPServer object where the logging database is created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. @@ -143,8 +153,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -162,8 +174,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,6 +184,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -180,8 +194,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,6 +204,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server Subscription Edition + Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -198,8 +214,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -209,6 +224,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -216,7 +234,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageLogFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageLogFile.md index dc3cb58c0..53b3963a6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageLogFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUsageLogFile.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Starts a new usage log file on the current server computer. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The usage data in memory is flushed to the current usage log file before the new For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------- +### EXAMPLE ```powershell New-SPUsageLogFile ``` This example terminates the current usage log file and creates a new one. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +50,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUser.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUser.md index d1d4bc475..62d9588ca 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUser.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUser.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds an existing user to a SharePoint site with the designated permissions. - ## SYNTAX ``` @@ -31,18 +30,16 @@ If only an alias is given and the farm is in Active Directory Account Create mod For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell New-SPUser -UserAlias 'Contoso\Jdow'-DisplayName 'Jane Dow' -Web https://contoso.com ``` This example adds a new user named Jane Dow to the Contoso domain. - -### ------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPWeb https://sitename | New-SPUser -UserAlias Contoso\Jdow ``` @@ -50,17 +47,18 @@ Get-SPWeb https://sitename | New-SPUser -UserAlias Contoso\Jdow This example adds Contoso\Jdow to all webs in the https://sitename site collection. Because this site collection uses inherited permissions, only the top-level web site needs to be touched. - ## PARAMETERS ### -UserAlias + +> Applicable: SharePoint Server Subscription Edition + Specifies the user alias from Active Directory Domain Services (AD DS). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the web on which to create this user. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-5678-9876-0987. @@ -77,8 +78,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +102,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +112,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +122,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,6 +131,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies a string that contains the display name of the user. The type must be a valid user name; for example, Joe. @@ -134,8 +141,7 @@ The type must be a valid user name; for example, Joe. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +151,9 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server Subscription Edition + Specifies the email address of the new user. The type must be a valid email address, in the form someone@contoso.com. @@ -152,8 +161,7 @@ The type must be a valid email address, in the form someone@contoso.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,13 +171,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server Subscription Edition + Specifies the user group to which the new user belongs. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,6 +189,9 @@ Accept wildcard characters: False ``` ### -PermissionLevel + +> Applicable: SharePoint Server Subscription Edition + Adds a user to a permission level. The type must be a valid permission level for the web application; for example, Full Control, Read, Contribute, or All. @@ -186,8 +199,7 @@ The type must be a valid permission level for the web application; for example, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,13 +209,15 @@ Accept wildcard characters: False ``` ### -SiteCollectionAdmin + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to add the user as an administrator to the site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -213,6 +227,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -220,7 +237,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserLicenseMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserLicenseMapping.md index 04a5c73e2..41610c04a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserLicenseMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a license mapping object. - ## SYNTAX ### TrustIdentity @@ -55,10 +54,9 @@ After the object is created you can pipe the result to the `Add-SPUserLicenseMap For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE---------------------------) +### EXAMPLE) ```powershell $a = New-SPUserLicenseMapping -SecurityGroup EntSecGroup -License Enterprise $a | Add-SPUserLicenseMapping @@ -66,18 +64,19 @@ $a | Add-SPUserLicenseMapping This example creates a license mapping object for the Active Directory secured group named 'EntSecGroup' and then pipes the result to the `Add-SPUserLicenseMapping` cmdlet. - ## PARAMETERS ### -Claim + +> Applicable: SharePoint Server Subscription Edition + Specifies the claims principal to license. The value must be an authentic claims principal. ```yaml Type: SPClaim Parameter Sets: TrustIdentity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,14 +86,16 @@ Accept wildcard characters: False ``` ### -ClaimType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of the claim. The value must be an authentic name of a claim type. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -104,14 +105,16 @@ Accept wildcard characters: False ``` ### -License + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of a supported SharePoint user license. For the full list of supported licenses on a SharePoint farm, see the `Get-SPUserLicense` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -121,14 +124,16 @@ Accept wildcard characters: False ``` ### -OriginalIssuer + +> Applicable: SharePoint Server Subscription Edition + Specifies the original issuer of the claim. The value must be the authentic name of an original issuer. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,14 +143,16 @@ Accept wildcard characters: False ``` ### -Role + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of a forms-based role. The value must be an authentic name of a forms-based role. ```yaml Type: String Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -155,14 +162,16 @@ Accept wildcard characters: False ``` ### -RoleProviderName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of a role provider. The value must be an authentic name of a role provider. ```yaml Type: String Parameter Sets: FormsAuth -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -172,14 +181,16 @@ Accept wildcard characters: False ``` ### -SecurityGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of an AD DS security group. The value must be a name of an Active Directory security group. ```yaml Type: String Parameter Sets: WindowsAuth -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -189,14 +200,16 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: SharePoint Server Subscription Edition + Specifies the value of the claim. The value must be an authentic claim value. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -206,6 +219,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -217,8 +233,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -228,6 +243,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -235,7 +253,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -245,14 +262,16 @@ Accept wildcard characters: False ``` ### -ValueType + +> Applicable: SharePoint Server Subscription Edition + Specifies the value type of the claim. The value must be an authentic name of a claim value type. ```yaml Type: String Parameter Sets: ClaimsValues -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -262,6 +281,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, web application name, or web application object instance where the mapping is to be added. If you omit this parameter, the mapping is applied to the entire farm. @@ -270,8 +292,7 @@ The type must be an URL in the form http://server_name or http://server_name/sit ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -281,6 +302,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -288,7 +312,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSettingsProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSettingsProvider.md index 0dae122e9..8496fa07d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSettingsProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new User Settings Provider. - ## SYNTAX ``` @@ -25,27 +24,27 @@ Use the `New-SPUserSettingsProvider` cmdlet to add a new User Settings Provider For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ```powershell New-SPUserSettingsProvider -DisplayName "My User Settings Provider" -AssemblyName MyProvider.dll -Type MyProvider ``` This example adds a user setting provider with a display name of "My User Settings Provider" which uses the MyProvider.dll file. - ## PARAMETERS ### -AssemblyName + +> Applicable: SharePoint Server Subscription Edition + Specifies the assembly name for the provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,13 +54,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name to use for this provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,13 +72,15 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type name to use for this provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +90,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +104,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSolutionAllowList.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSolutionAllowList.md index baf7eb079..6cdfca8f9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSolutionAllowList.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPUserSolutionAllowList.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a user managed solutions gallery. - ## SYNTAX ``` @@ -23,19 +22,20 @@ New-SPUserSolutionAllowList [-AssignmentCollection ] [-C ## DESCRIPTION Creates a user managed solutions gallery. - ## EXAMPLES -### ----------------------- EXAMPLE--------------------------- +### EXAMPLE ```powershell New-SPUserSolutionAllowList -Site https://contoso/sites/site1 -ListTitle "Allow List" ``` This example creates a user managed solutions gallery named "Allow List" under the root web of the site collection at https://contoso/sites/site1. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -70,13 +71,15 @@ Accept wildcard characters: False ``` ### -ListTitle + +> Applicable: SharePoint Server Subscription Edition + Specifies the title of the user solution allow list to create. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,13 +89,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the user solution allow list will be created. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -109,7 +117,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioSafeDataProvider.md index a02bf73f0..14161595a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioSafeDataProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new data provider to a Visio Services application. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `New-SPVisioSafeDataProvider` cmdlet adds a new data provider to the list of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ```powershell New-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 -Description "Custom Data Provider" ``` This example creates a new safe data provider for a specified Visio Services application. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the data provider to create. The combination of DataProviderID and DataProviderType uniquely identify a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -49,8 +49,7 @@ The type must be a valid string that identifies the data provider; for example, ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid identity of a data provider type. Specifies the supported type of the data provider to add. @@ -68,8 +70,7 @@ Custom data types are supported; for example, Excel Services. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application in which to add the new safe data provider. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -86,8 +90,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description of the new safe data provider. The type must be a string with a maximum of 4096 characters. @@ -126,8 +134,7 @@ The type must be a string with a maximum of 4096 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplication.md index 0d234211c..4860b9899 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new Visio Services application to a farm. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `New-SPVisioServiceApplication` cmdlet adds a new Visio Services application For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' -CreateDefaultProxy ``` This example creates a new Visio Services application named 'Visio Graphics Service Application' and also creates a service application proxy associated with it. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -AddToDefaultGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that a default proxy is created for the new Visio Services application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +88,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application to create. The type must be a valid name of a Visio Service application; for example, MyVisioService1. @@ -119,8 +127,7 @@ The type must be a valid name of a Visio Service application; for example, MyVis ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplicationProxy.md index 823186acd..70b09cb57 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPVisioServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds a new Visio Services application proxy to a farm. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `New-SPVisioServiceApplicationProxy` cmdlet adds a new Visio Services applic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------ +### EXAMPLE ```powershell $sa = New-SPVisioServiceApplication -Identity 'Visio Graphics Service Application' -ApplicationPool 'SharePoint Web Services Default' New-SPVisioServiceApplicationProxy -Identity 'Visio Graphics Service Application Proxy' -ServiceApplication $sa @@ -36,10 +34,12 @@ New-SPVisioServiceApplicationProxy -Identity 'Visio Graphics Service Application This example creates a new Visio Services application proxy connected to a Visio Services application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that is associated with the application proxy. The type must be a valid name of a Visio Services application; for example, MyVisioService1. @@ -47,8 +47,7 @@ The type must be a valid name of a Visio Services application; for example, MyVi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application proxy to create. The type must be a valid name of a Visio Services application; for example, MyVisioService1. @@ -87,8 +91,7 @@ The type must be a valid name of a Visio Services application; for example, MyVi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPIBinding.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPIBinding.md index 46e03db4b..23e716dac 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPIBinding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPIBinding.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new binding to associate file name extensions or applications with actions on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -32,27 +31,28 @@ If you run `New-SPWOPIBinding` for an application or file name extension where t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" ``` This example creates bindings for all the applications and file name extensions that the WOPI application supports on the current SharePoint farm where this cmdlet is run. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell New-SPWOPIBinding -ServerName "Server.corp.Contoso.com" -Application "Excel" ``` This example associates Excel with all the actions that the WOPI application supports for Excel on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -ServerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or fully qualified domain name (FQDN) of the WOPI application (such as a server that runs Office Web Apps Server). This can also be an FQDN of a load balanced endpoint for multiple Office Web Apps servers. @@ -60,8 +60,7 @@ This can also be an FQDN of a load balanced endpoint for multiple Office Web App ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: SharePoint Server Subscription Edition + Specifies the action to bind. For example, "view," "edit," and "embedview." For a list of actions that the WOPI application supports, run `Get-SPWOPIBinding`. @@ -81,8 +83,7 @@ If you specify some actions but not others, some SharePoint features may not wor ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +93,9 @@ Accept wildcard characters: False ``` ### -AllowHTTP + +> Applicable: SharePoint Server Subscription Edition + Specifies that the cmdlet can use HTTP for discovery of what the WOPI application supports. If this is specified as True, the discovery information from the WOPI application will be sent on a nonsecure connection. @@ -99,8 +103,7 @@ If this is specified as True, the discovery information from the WOPI applicatio ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server Subscription Edition + Specifies applications to bind. Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the full list of application the WOPI application supports. @@ -117,8 +123,7 @@ Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +133,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -135,8 +143,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +163,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,6 +172,9 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extensions to bind. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. @@ -170,8 +182,7 @@ Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI applica ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -181,6 +192,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the xml file that contains the discover information for the WOPI application. You can load discovery information from an xml file instead of requesting from the WOPI application directly. @@ -188,8 +202,7 @@ You can load discovery information from an xml file instead of requesting from t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,6 +212,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server Subscription Edition + Specifies the programmatic identifier (ProgID) for an application to bind. Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. @@ -208,8 +224,7 @@ You may only want to use this parameter to associate an action to an OneNote fol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -219,6 +234,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -226,7 +244,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPISuppressionSetting.md index 977e0fb25..b279d1467 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWOPISuppressionSetting.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Disables Office Web Apps for the action, file name extension, or programmatic identifier that you've specified on the current SharePoint farm. - ## SYNTAX ``` @@ -21,16 +20,15 @@ New-SPWOPISuppressionSetting [-Action ] [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Specifies the action to suppress for a given extension or programmatic identifier (ProgId). For example, "view," "edit," and "embedview." For a full list of actions, run `Get-SPWOPIBinding`. @@ -49,8 +49,7 @@ For example, "view," "edit," and "embedview." For a full list of actions, run `G ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extension to suppress. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. @@ -102,8 +108,7 @@ Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI applica ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server Subscription Edition + Specifies the programmatic identifier (ProgId) for an application to suppress. Run `Get-SPWOPIBinding` to get the list of ProgIds that the WOPI application supports. @@ -120,8 +128,7 @@ Run `Get-SPWOPIBinding` to get the list of ProgIds that the WOPI application sup ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -138,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWeb.md index 06ab6c656..6e8d0aa28 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWeb.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new site in an existing site collection. - ## SYNTAX ``` @@ -30,10 +29,9 @@ If no template is specified, the site is created and the template can be provide For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPWeb https://somesite/subweb1 -Template "STS#0" ``` @@ -41,10 +39,12 @@ New-SPWeb https://somesite/subweb1 -Template "STS#0" This example creates a new subsite by using the Team Site template at the provided URL (https://somesite/subweb1). The Team Site template is a value referenced as the variable STS#0 for the Template parameter. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL where the new site is to be created. The URL must be inside an existing site collection. The URL must be a valid URL, in the form https://server_name/site1. @@ -52,8 +52,7 @@ The URL must be a valid URL, in the form https://server_name/site1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the language template identifier for the new site. If no language is specified, the site is created with the same language that was specified when the product was installed. @@ -71,8 +73,7 @@ The type must be a valid language identifier (LCID). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web template for the new site. The template must already exist. If no template is specified, no template is applied and a template can be selected later. @@ -89,8 +93,7 @@ If no template is specified, no template is applied and a template can be select ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the title of the new site. If no title is specified, the default title is applied. The default title is configured for each template. @@ -107,8 +113,7 @@ The default title is configured for each template. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,14 +123,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Describes the new site. If no description is specified, the entry is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,13 +142,15 @@ Accept wildcard characters: False ``` ### -AddToQuickLaunch + +> Applicable: SharePoint Server Subscription Edition + Adds this site to the Quick Launch. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,13 +160,15 @@ Accept wildcard characters: False ``` ### -UniquePermissions + +> Applicable: SharePoint Server Subscription Edition + Specifies that this site is to be created with unique permissions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -AddToTopNav + +> Applicable: SharePoint Server Subscription Edition + Adds this site to the top-level navigation bar. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -UseParentTopNav + +> Applicable: SharePoint Server Subscription Edition + Specifies that the same top-level navigation bar as the parent site is to be used for this site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,6 +214,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -210,8 +228,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,6 +238,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -228,7 +248,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -238,6 +257,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -245,7 +267,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplication.md index bf259e4f2..7aea33787 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Web application within the local farm. - ## SYNTAX ``` @@ -35,29 +34,28 @@ The user specified by the DatabaseCredentials parameter must be a member of the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell New-SPWebApplication -Name "Contoso Internet Site" -Port 80 -HostHeader sharepoint.contoso.com -URL "http://www.contoso.com" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") ``` This example creates a new web application by using an internal host header of sharepoint.contoso.com and a public URL of http://www.contoso.com. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell New-SPWebApplication -Name "Contoso Internet Site" -Port 443 -SecureSocketsLayer -HostHeader sharepoint.contoso.com -URL "https://www.contoso.com:443" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") ``` This example creates a new SSL enabled web application by using an internal host header of sharepoint.contoso.com and a public URL of https://www.contoso.com. -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell $ap = New-SPAuthenticationProvider -New-SPWebApplication -Name "Contoso Internet Site" -URL "https://www.contoso.com" -Port 443 --ApplicationPool "ContosoAppPool" --ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") +New-SPWebApplication -Name "Contoso Internet Site" -URL "https://www.contoso.com" -Port 443 +-ApplicationPool "ContosoAppPool" +-ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\wa") -AuthenticationProvider $ap -SecureSocketsLayer ``` @@ -66,13 +64,15 @@ Creates a Windows Claims web application at the URL https://www.contoso.com usin ## PARAMETERS ### -AdditionalClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Adds a specific claim provider to the defined web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,13 +82,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymousAccess + +> Applicable: SharePoint Server Subscription Edition + Allows anonymous access to the web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +100,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -110,7 +115,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,6 +124,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of an application pool to use; for example, SharePoint - 1213. If an application pool with the name provided does not exist, the ApplicationPoolAccount parameter must be provided and a new application pool will be created. If no value is specified, the default application pool will be used. @@ -127,8 +134,7 @@ If no value is specified, the default application pool will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,14 +144,16 @@ Accept wildcard characters: False ``` ### -ApplicationPoolAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies the user account that this application pool will run as. Use the `Get-SPIisWebServicApplicationPool` cmdlet to use a system account. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +163,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -166,8 +177,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,14 +187,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server Subscription Edition + Uses Kerberos or NTLM to specify the authentication method. If no value is specified, the default NTLM is applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,13 +206,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication provider or providers that apply to a Web application. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -210,6 +224,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the certificate that will be used for the Secure Sockets Layer (SSL) binding of this IIS website. This parameter is only valid when used with the SecureSocketsLayer parameter. @@ -217,7 +234,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SPServerCertificatePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -227,13 +243,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the Windows PowerShell Credential object for the database user account. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,6 +261,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the initial content database for the new Web application. The type must be a valid database name; for example, ContentDB1. @@ -251,8 +272,7 @@ If no value is specified, a value in the format WSS_Content_\ is auto-gen ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -262,6 +282,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server name. The type must be a valid database server name, in the form SQL1; where named instances are used, the format can appear as server\server. The default SQL server instance is used if a value is not provided. @@ -269,8 +292,7 @@ The default SQL server instance is used if a value is not provided. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -280,6 +302,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies the host header binding for this IIS web site. A host header binding allows multiple IIS websites to share the same port number. Web requests sent to a shared port number are routed to the correct IIS website based on the value of the HTTP host header sent by the client. @@ -289,8 +314,7 @@ If no host header binding is specified, then all web requests sent to this port ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -300,13 +324,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -316,6 +342,9 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the physical directory for the new web application in the virtual directories folder. The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. If no value is specified, the value %wwwroot%\wss\VirtualDirectories\\\ is applied. @@ -323,8 +352,7 @@ If no value is specified, the value %wwwroot%\wss\VirtualDirectories\\\ Applicable: SharePoint Server Subscription Edition + Specifies the port on which this Web application can be accessed. This can be any valid port number. If no port is specified, a nonconflicting port number is automatically generated. @@ -343,8 +374,7 @@ If you specify a port number that has already been assigned, IIS does not start ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -354,6 +384,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Enables Secure Sockets Layer (SSL) encryption for this Web application. If you choose to use SSL, you must import a server certificate to SharePoint and assign it to the IIS website for this web application. Until this is done, the Web application will be inaccessible from this IIS website. @@ -365,8 +398,7 @@ If this parameter is omitted or set to False, this web application will use HTTP ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -376,6 +408,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the default proxy group for the farm is used. @@ -384,7 +419,6 @@ If this parameter is not specified, the default proxy group for the farm is used Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) Aliases: ProxyGroup -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -394,13 +428,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server Subscription Edition + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -410,13 +446,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign-in redirect URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -426,13 +464,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the load-balanced URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -442,13 +482,15 @@ Accept wildcard characters: False ``` ### -UserSettingsProvider + +> Applicable: SharePoint Server Subscription Edition + Provides access to external user settings provider. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -458,6 +500,9 @@ Accept wildcard characters: False ``` ### -UseServerNameIndication + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Sockets Layer (SSL) binding of this IIS website should use Server Name Indication (SNI). Server Name Indication allows multiple IIS websites with unique host headers and unique server certificates to share the same SSL port. If Server Name Indication isn't used, all IIS websites sharing the same SSL port must share the same server certificate. @@ -466,7 +511,6 @@ If Server Name Indication isn't used, all IIS websites sharing the same SSL port Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -476,6 +520,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -483,7 +530,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -493,6 +539,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -500,7 +549,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationAppDomain.md index ee4f1aa1f..bfb318ccf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationAppDomain.md @@ -13,7 +13,6 @@ schema: 2.0.0 Creates an AppDomain entry. - ## SYNTAX ``` @@ -26,10 +25,9 @@ New-SPWebApplicationAppDomain [-AppDomain] -WebApplication Applicable: SharePoint Server Subscription Edition + Specifies the URI of the app domain. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -66,14 +65,14 @@ Accept wildcard characters: False ### -WebApplication -Specifies the GUID, URI, or name of the web application for which the app domain is being configured. +> Applicable: SharePoint Server Subscription Edition +Specifies the GUID, URI, or name of the web application for which the app domain is being configured. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -84,6 +83,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -92,7 +93,6 @@ When the Global parameter is used, all objects are contained in the global store Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -103,13 +103,14 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,13 +121,14 @@ Accept wildcard characters: False ### -Port +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS port number to which the app domain will be assigned. If no value is specified, the same port used by the web application for the zone is applied. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,13 +139,14 @@ Accept wildcard characters: False ### -SecureSocketsLayer +> Applicable: SharePoint Server Subscription Edition + Specifies that the app domain will use Secured Sockets Layer (SSL) security. If no value is specified, no SSL security will be used. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -154,6 +157,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -161,7 +166,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -172,6 +176,8 @@ Accept wildcard characters: False ### -Zone +> Applicable: SharePoint Server Subscription Edition + Specifies the security zone to which the app domain will be assigned. * Default @@ -190,7 +196,6 @@ If no value is specified, Default is applied. Type: SPUrlZone Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationExtension.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationExtension.md index 8d8890538..b1905e17d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationExtension.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWebApplicationExtension.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new zone instance for the Web application. - ## SYNTAX ``` @@ -32,27 +31,27 @@ This is also known as extending a Web application and allows alternate permissio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPWebApplication http://sitename | New-SPWebApplicationExtension -Name "ExtranetSite" -SecureSocketsLayer -Zone "Extranet" -URL "https://extranet.sitename.com" ``` This example extends the given Web application at http://sitename to the Extranet zone for SSL use. - ## PARAMETERS ### -AdditionalClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Adds a specific claim provider to the defined web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -AllowAnonymousAccess + +> Applicable: SharePoint Server Subscription Edition + Allows anonymous access to the web application zone. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -90,7 +94,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +117,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,13 +127,15 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server Subscription Edition + Uses Kerberos or NTLM to specify the authentication method. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,13 +145,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the authentication provider(s) that applies to a Web apllication. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,6 +179,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies the host header binding for this IIS website. A host header binding allows multiple IIS websites to share the same port number. Web requests sent to a shared port number are routed to the correct IIS website based on the value of the HTTP host header sent by the client. @@ -179,8 +191,7 @@ If no host header binding is specified, then all web requests sent to this port ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -190,13 +201,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application to extend. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -206,13 +219,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new IIS website in the web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -222,14 +237,16 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the physical directory for the new website (in the virtual directories folder). The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -239,6 +256,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: SharePoint Server Subscription Edition + Specifies the application port. Can be any valid port number. @@ -249,8 +269,7 @@ If you specify a port number that is already assigned, IIS does not start the ne ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -260,6 +279,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Enables Secure Sockets Layer (SSL) encryption for this Web application. If you choose to use SSL, you must import a server certificate to SharePoint and assign it to the IIS website for this web application. Until this is done, the web application will be inaccessible from this IIS website. @@ -271,8 +293,7 @@ If this parameter is omitted or set to False, this web application will use HTTP ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -282,13 +303,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server Subscription Edition + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -298,13 +321,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign-in redirect URL for the Web application. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -314,13 +339,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the load-balanced URL for the Web application zone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -330,6 +357,9 @@ Accept wildcard characters: False ``` ### -UseServerNameIndication + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Sockets Layer (SSL) binding of this IIS website should use Server Name Indication (SNI). Server Name Indication allows multiple IIS websites with unique host headers and unique server certificates to share the same SSL port. If Server Name Indication isn't used, all IIS websites sharing the same SSL port must share the same server certificate. @@ -338,7 +368,6 @@ If Server Name Indication isn't used, all IIS websites sharing the same SSL port Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -348,6 +377,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the five zones with which the internal URL of this new extension is to be associated. This zone cannot already be in use. @@ -356,8 +388,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -367,6 +398,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -374,7 +408,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -384,6 +417,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -391,7 +427,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWordConversionServiceApplication.md index 60af939b2..b31921502 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWordConversionServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWordConversionServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new instance of a Word Automation Services application on the farm. - ## SYNTAX ``` @@ -27,20 +26,21 @@ The `New-SPWordConversionServiceApplication` cmdlet creates a new instance of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPWordConversionServiceApplication -Name 'Word Conversion Services' -ApplicationPool 'SharePoint Web Services Default' -DatabaseName 'Word' ``` This example creates a new Word Automation Services application named Word Conversion Services in an existing application pool named SharePoint Web Services Default. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new Word Automation Services application. The type must be a valid name of a Word Automation Services application; for example, WordSvcApp1. @@ -48,8 +48,7 @@ The type must be a valid name of a Word Automation Services application; for exa ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS-managed application pool in which this instance of Word Automation Services runs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -66,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -84,8 +88,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use for connecting to the database for the Word Automation Services application. Use this parameter only if SQL Server Authentication is used to access the service application database. @@ -120,8 +128,7 @@ When the DatabaseCredential parameter is specified, the DatabaseName and Databas ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the new Word Automation Services application. The type must be a valid SQL database name; for example, MetadataDB1. @@ -138,8 +148,7 @@ The type must be a valid SQL database name; for example, MetadataDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +158,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the Word Automation Services database. The type must be a valid SQL database server host name; for example, SQLServerHost1. @@ -156,8 +168,7 @@ The type must be a valid SQL database server host name; for example, SQLServerHo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,13 +178,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + Specifies that the service application proxy is added to the farm's default proxy group for this Web application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -183,14 +196,16 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies that this service behaves uniquely on a partitioned set of site collections. This property cannot be changed after the application is provisioned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -207,7 +225,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWorkflowServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWorkflowServiceApplicationProxy.md index 6f59a3ea2..b1d1493e4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWorkflowServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/New-SPWorkflowServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a proxy to connect to Workflow Manager. - ## SYNTAX ``` @@ -25,20 +24,21 @@ Creates a proxy to connect to Workflow Manager. Note: Consider using the cmdlet `Register-SPWorkflowService` instead which binds a Workflow Manager farm and creates the Workflow Service Proxy. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell New-SPWorkflowServiceApplicationProxy ``` Creates a Workflow Service Application Proxy. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,14 +74,15 @@ Accept wildcard characters: False ``` ### -PartitionMode -Specifies that the service application restrict data by subscription. +> Applicable: SharePoint Server Subscription Edition + +Specifies that the service application restrict data by subscription. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,6 +92,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -97,7 +102,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Pause-SPProjectWebInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Pause-SPProjectWebInstance.md index 72da859ac..9a0abd901 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Pause-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Pause-SPProjectWebInstance.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/pause-spprojectwebinstance -Applicable: SharePoint Server Subscription Edition + title: Pause-SPProjectWebInstance schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server PSI or CSOM. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Switches the specified instance of Project Web App to read-only, preventing any For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} $instance = Get-SPProjectWebInstance -ServiceApplication $sa @@ -40,14 +38,16 @@ Pauses the Project Web Server Instance in the Project Web Application Service Ap ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the instance of Project Web App to be switched to read-only mode. It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Publish-SPServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Publish-SPServiceApplication.md index 65d925224..705528d8e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Publish-SPServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Publish-SPServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Shares the specified local service application outside the farm. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Publish-SPServiceApplication` cmdlet publishes the local service applicatio For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Publish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -Description "Connect to this TestServiceApplcation of you want to use FeatureA in your farm" -InfoLink https://testurl ``` @@ -39,10 +37,12 @@ This example publishes a service application to another farm. The service application GUID is unique to every farm. You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, `Grant-SPServiceApplication`. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application to share outside the farm. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,14 +103,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Describes the service application to share outside the farm. If no value is specified, the value is left blank. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -InfoLink + +> Applicable: SharePoint Server Subscription Edition + Specifies the link to more information about the service application to share outside the farm. If no link is specified, no link is made available. @@ -125,8 +133,7 @@ The type must be a valid URL, in the form https://server_name/Site_Name/page_na ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Receive-SPServiceApplicationConnectionInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Receive-SPServiceApplicationConnectionInfo.md index 0bb48bc06..d11eb414d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Receive-SPServiceApplicationConnectionInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Receive-SPServiceApplicationConnectionInfo.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures this farm to receive service information from another farm. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Receive-SPServiceApplicationConnectionInfo` cmdlet retrieves the list of se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Receive-SPServiceApplicationConnectionInfo -FarmUrl https://FarmB/topology/topology.svc ``` @@ -37,10 +35,12 @@ This example retreives a list of service applications published by a given farm. The FarmURL parameter can be obtained by the `Get-SPTopologyServiceApplication` cmdlet. - ## PARAMETERS ### -FarmUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the farm from which to receive service application information. The type must be a valid URL, in the form https://site_name. @@ -48,8 +48,7 @@ The type must be a valid URL, in the form https://site_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: SharePoint Server Subscription Edition + Specifies a filter to use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPAppPrincipal.md b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPAppPrincipal.md index 7f3db4204..50aa3892b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPAppPrincipal.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPAppPrincipal.md @@ -22,13 +22,11 @@ Register-SPAppPrincipal -DisplayName -NameIdentifier -Site " Register-SPAppPrincipal -site $site.RootWeb -NameIdentifier "00000003-0000-0ff1-ce00-000000000000@f686d426-8d16-42db-81b7-cb578e110ccd" -DisplayName "Contoso" @@ -36,17 +34,18 @@ Register-SPAppPrincipal -site $site.RootWeb -NameIdentifier "00000003-0000-0ff1- This example registers the app principal named Contoso. - ## PARAMETERS ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the friendly name to use for the app principal that is being registered. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -NameIdentifier + +> Applicable: SharePoint Server Subscription Edition + Specifies the app principal's name identifier that needs to be added to the app management service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,13 +73,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + {{Fill Site Description}} ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +91,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +105,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPRemoteShareBlobStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPRemoteShareBlobStore.md index f3110d159..1a5361ebf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPRemoteShareBlobStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPRemoteShareBlobStore.md @@ -25,7 +25,7 @@ The \`Register-SPRemoteShareBlobStore\` cmdlet registers a new BLOB store for th ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Register-SPRemoteShareBlobStore -ContentDatabase WSS_Content -Name "RemoteBlob" -Location "\\storage_name\blobstore\" ``` @@ -35,6 +35,9 @@ This example registers \\\\storage_name\blobstore\ with name "RemoteBlob" to con ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -BlobStoreCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use to connect to the BLOB store. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies a content database to register the Remote Share BLOB Store. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -Location + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the SMB storage this BLOB store will use. You must use a Universal Naming Convention (UNC) share path. For example: \\\\storage_name\blobstore. @@ -96,7 +105,6 @@ For example: \\\\storage_name\blobstore. Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new BLOB store. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -122,6 +132,9 @@ Accept wildcard characters: False ``` ### -PoolCapacity + +> Applicable: SharePoint Server Subscription Edition + The number of BLOB chunks in each BLOB pool. If this parameter is not specified, it will be set to 1000. @@ -130,7 +143,6 @@ If this parameter is not specified, it will be set to 1000. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -140,13 +152,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -156,6 +170,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -163,7 +180,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPVssWriter.md b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPVssWriter.md index b42c673c5..0365e88b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPVssWriter.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPVssWriter.md @@ -24,7 +24,7 @@ This allows the Volume Shadow Copy Service (VSS) to back up and restore SharePoi ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Register-SPVssWriter ``` @@ -34,6 +34,9 @@ Registers the SharePoint VSS Writer service on the local server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPWorkflowService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPWorkflowService.md index 5719e6adc..e561e8e8d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPWorkflowService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Register-SPWorkflowService.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Registers a Workflow Manager farm with the SharePoint farm. - ## SYNTAX ``` @@ -23,10 +22,9 @@ Register-SPWorkflowService [-AllowOAuthHttp] [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Allows connecting to Workflow Manager using HTTP rather than HTTPS. This is not recommended for security. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -51,6 +51,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -62,8 +65,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the registration, even if previously registered. Will overwrite the existing Scope. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,13 +93,15 @@ Accept wildcard characters: False ``` ### -PartitionMode + +> Applicable: SharePoint Server Subscription Edition + Specifies to use a SharePoint multi-tenancy features when registering Workflow Manager. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -105,13 +111,15 @@ Accept wildcard characters: False ``` ### -SPSite + +> Applicable: SharePoint Server Subscription Edition + The Site Collection used as a reference to register Workflow Manager with the SharePoint farm. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -121,13 +129,15 @@ Accept wildcard characters: False ``` ### -ScopeName + +> Applicable: SharePoint Server Subscription Edition + The name of the scope in Workflow Manager to use. if not specified, the default Scope will be used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,13 +147,15 @@ Accept wildcard characters: False ``` ### -WorkflowHostUri + +> Applicable: SharePoint Server Subscription Edition + The URI on which the Workflow Manager is hosted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPActivityFeedItems.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPActivityFeedItems.md index 93f1a7bfc..c0eb95007 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPActivityFeedItems.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPActivityFeedItems.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes activity events from the published and consolidated tables. - ## SYNTAX ``` @@ -24,10 +23,9 @@ Remove-SPActivityFeedItems [-AllItems ] [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Specifies whether to delete events.A value of "1" deletes all events. A value of "0", no events are deleted.The default value is 0 (zero). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. **NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -63,8 +65,7 @@ Manages objects for the purpose of proper disposal. Use of objects, such as SPWe ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -ID + +> Applicable: SharePoint Server Subscription Edition + Limits events deleted to those which match the specified ActivityEventID. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -122,15 +129,17 @@ Accept wildcard characters: False ``` ### -SearchText -Limits events deleted to those which contain SearchText in the string. + +> Applicable: SharePoint Server Subscription Edition + +Limits events deleted to those which contain SearchText in the string. Note that the SearchText will apply to *all* of the XML text saved in SQL representing this activity. The text seen in a browser window may be saved in a different representation in SQL. For example, a ">" feed symbol may be represented as ">" text in SQL, so the SearchText should reference ">" instead of ">". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,15 +149,17 @@ Accept wildcard characters: False ``` ### -SiteSubscription -Specifies the account under which this service should run. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -158,6 +169,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -165,7 +179,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAlternateURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAlternateURL.md index a84b49adb..e1c154e9a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAlternateURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAlternateURL.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Completely deletes the specified alternate URL. - ## SYNTAX ``` @@ -25,36 +24,35 @@ The `Remove-SPAlternateUrl` cmdlet completely deletes the alternate URL specifie For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Remove-SPAlternateURL -Identity http://sitename ``` This example deletes the http://sitename alternate URL from the farm. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Remove-SPAlternateURL ``` This example removes all extranet alternate URLs in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the alternate URL to delete. The identity can be either a valid URL, in the form https://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -86,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -103,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppDeniedEndpoint.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppDeniedEndpoint.md index ad2963598..07965e311 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppDeniedEndpoint.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppDeniedEndpoint.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a relative URL endpoint of a server from the list of app-denied endpoints. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPAppDeniedEndpoint` cmdlet to remove a relative URL endpoint of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" ``` @@ -36,18 +34,19 @@ Remove-SPAppDeniedEndpoint -Endpoint "/_vti_bin/contoso/service.asmx" This example removes the "/_vti_bin/contoso/service.asmx" endpoint from the list of denied endpoints for apps. Apps will be able to access this endpoint because it is being removed from the app-denied endpoint list. - ## PARAMETERS ### -Endpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies a relative URL endpoint of a server that will be removed from the list of app-denied endpoints. Apps will not be able to access relative URL endpoints of a server that exist in the app-denied endpoint list. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppPrincipalPermission.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppPrincipalPermission.md index 450b056ed..a0ccf3bf1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppPrincipalPermission.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPAppPrincipalPermission.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the permissions on a specified app principal. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the `Remove-SPAppPrincipalPermission` cmdlet to remove the permissions on a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE------------ +### EXAMPLE ```powershell $clientID = "11111111-2222-3333-4444-555555555555" $site = Get-SPSite http://siteUrl @@ -41,17 +39,18 @@ Remove-AppPrincipalPermission -AppPrincipal $appPrincipal -Site $site.RootWeb -S This example removes the App Principal permission from the site collection scope. - ## PARAMETERS ### -AppPrincipal + +> Applicable: SharePoint Server Subscription Edition + Specifies the AppPrincipal object to remove. ```yaml Type: SPAppPrincipal Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope to which to apply the principal permission. The value is any of the following scopes: @@ -74,8 +76,7 @@ The value is any of the following scopes: ```yaml Type: SPCmdletAppPrincipalPermissionScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site (that is, SPWeb object) to remove. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -108,8 +114,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,13 +162,15 @@ Accept wildcard characters: False ``` ### -DisableAppOnlyPolicy + +> Applicable: SharePoint Server Subscription Edition + Disables the app only policy. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPApplicationCredentialKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPApplicationCredentialKey.md index c7d78e265..6d1e0b646 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPApplicationCredentialKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPApplicationCredentialKey.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/remove-spapplicationcredentialkey -Applicable: SharePoint Server Subscription Edition + title: Remove-SPApplicationCredentialKey schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the application credential key from the local server. - ## SYNTAX ``` @@ -20,13 +19,12 @@ Remove-SPApplicationCredentialKey [-AssignmentCollection ] ``` - ## DESCRIPTION Use the **Remove-SPApplicationCredentialKey** cmdlet to remove the application credential key from the local server. The application credential key is used by certain features to encrypt and decrypt passwords. ## EXAMPLES -### ------------EXAMPLE ----------- +### EXAMPLE ```powershell Remove-SPApplicationCredentialKey -Confirm:$false ``` @@ -35,6 +33,9 @@ This example removes the application credential key from the local server withou ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +48,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -56,13 +57,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -71,6 +75,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -78,7 +85,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -90,5 +97,4 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPBusinessDataCatalogModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPBusinessDataCatalogModel.md index 6a1bb5655..ba09f4d81 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPBusinessDataCatalogModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPBusinessDataCatalogModel.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a Business Data Connectivity Model. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Remove-SPBusinessDataCatalogModel` cmdlet deletes a Business Data Connectiv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $modelFile = Get-SPBusinessDataCatalogMetadataObject -Name "ContosoModel" -BdcObjectType Model -ServiceContext http://contoso Remove-SPBusinessDataCatalogModel -Identity $modelFile @@ -36,17 +34,18 @@ Remove-SPBusinessDataCatalogModel -Identity $modelFile This example removes the Business Data Connectivity Model file named ContosoModel. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object to remove. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCentralAdministration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCentralAdministration.md index 25217457e..19a336732 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCentralAdministration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCentralAdministration.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/remove-spcentraladministration -Applicable: SharePoint Server Subscription Edition + title: Remove-SPCentralAdministration schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the SharePoint Central Administration web site from the local server. - ## SYNTAX ``` @@ -23,19 +22,20 @@ Remove-SPCentralAdministration [-AssignmentCollection ] ## DESCRIPTION Removes the SharePoint Central Administration web site from the local server. - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPCentralAdministration ``` This example removes the Central Administration web site from the local server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -70,6 +71,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -77,7 +81,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificate.md index 1668488b5..125ef453a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificate.md @@ -37,7 +37,7 @@ Those exported files will still exist. ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Remove-SPCertificate -Identity "Team Sites Certificate" ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificateNotificationContact.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificateNotificationContact.md index dee2782ca..5c6cb1285 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificateNotificationContact.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPCertificateNotificationContact.md @@ -24,7 +24,7 @@ The \`Remove-SPCertificateNotificationContact\` cmdlet deletes an email address ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Remove-SPCertificateNotificationContact -EmailAddress sharepoint-admins@example.com ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimProvider.md index f7863903f..a32accc34 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Unregisters a claim provider. - ## SYNTAX ``` @@ -26,20 +25,21 @@ If the unregistered claim provider was assigned to a trusted identity token issu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove - SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" ``` This example removes a claim provider from the farm - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the claim provider to unregister. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimTypeMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimTypeMapping.md index ba7e8fa48..a7d0ed2ac 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimTypeMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPClaimTypeMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a claim type mapping rule for a security token service (STS) identity provider. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPClaimTypeMapping` cmdlet deletes a claim type mapping rule from a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------- +### EXAMPLE ```powershell -Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" | Remove-SPClaimTypeMapping "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" +Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" | Remove-SPClaimTypeMapping "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" ``` This example removes the claim type mapping emailaddress from the LiveIDSTS identity provider. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the claim mapping to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimTypeMapping object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,13 +94,15 @@ Accept wildcard characters: False ``` ### -TrustedIdentityTokenIssuer + +> Applicable: SharePoint Server Subscription Edition + Specifies the token issuer or a valid SPTrustedIdentityTokenIssuerPipeBind object. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +122,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationDatabase.md index 52dd56750..01a49c191 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Permanently removes a configuration database. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The configuration database must be already dismounted from any associated farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPConfigurationDatabase ``` This example permanently deletes a configuration database from a farm. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +51,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -69,7 +71,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationObject.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationObject.md index 4aa2707bd..adb0d809e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationObject.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPConfigurationObject.md @@ -24,7 +24,7 @@ Remove-SPConfigurationObject [-Identity] [-Force] [-AssignmentCollection ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell {{ Add example code here }} ``` @@ -34,6 +34,9 @@ Remove-SPConfigurationObject [-Identity] [-Force] [-AssignmentCollection ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Force Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Identity Description }} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 0 @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -104,6 +112,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -111,7 +122,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDatabase.md index a6180887e..89b6b35d0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDatabase.md @@ -26,17 +26,16 @@ This will remove the content database from SharePoint Products but not from SQL For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE--------------------- +### EXAMPLE ```powershell Remove-SPContentDatabase WSS_Content ``` This example deletes the content database named 'WSS_Content'. -### -----------------EXAMPLE--------------------- +### EXAMPLE ```powershell Remove-SPContentDatabase WSS_Content -Confirm:$false -Force ``` @@ -46,6 +45,9 @@ This example deletes the content database named 'WSS_Content' without asking any ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database to delete. The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -53,8 +55,7 @@ The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +75,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,13 +123,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specifies the force of a removal. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentJob.md index cad6635bf..ffec18e43 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentJob.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a content deployment job. - ## SYNTAX ``` @@ -25,28 +24,28 @@ The `Remove-SPContentDeploymentJob` cmdlet removes a content deployment job. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPContentDeploymentJob -Identity "DeployJob1" ``` This example removes a deployment job named DeployJob1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment job to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployJob1); or an instance of a valid SPContentDeploymentJob object. ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentPath.md index afb55a800..c0ce855f3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPContentDeploymentPath.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a content deployment path. - ## SYNTAX ``` @@ -25,28 +24,28 @@ The `Remove-SPContentDeploymentPath` cmdlet removes a content deployment path. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPContentDeploymentPath -Path1 ``` This example removes a content path named Path1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment path to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment path (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDatabaseFromAvailabilityGroup.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDatabaseFromAvailabilityGroup.md index 781e8ce59..ade648373 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDatabaseFromAvailabilityGroup.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDatabaseFromAvailabilityGroup.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes one or more SharePoint databases from an availability group in SQL Server. - ## SYNTAX ### Default @@ -30,27 +29,27 @@ Remove-SPDatabaseFromAvailabilityGroup [-AGName] [-AssignmentCollection ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [https://msdn.microsoft.com/library/dd878348(VS.85).aspx](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell -Remove-SPDatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content +Remove-SPDatabaseFromAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content ``` This example removes the availability group named "MyAvailabilityGroup" from the WSS_Content database. - ## PARAMETERS ### -AGName + +> Applicable: SharePoint Server Subscription Edition + The name of the availability group from which the databases are being removed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,15 +79,17 @@ Accept wildcard characters: False ``` ### -DatabaseName -The name of the database to be removed from the availability group. + +> Applicable: SharePoint Server Subscription Edition + +The name of the database to be removed from the availability group. NOTE: This parameter should not be used in conjunction with the ProcessAllDatabases parameter. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces a remove from the group. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -KeepSecondaryData + +> Applicable: SharePoint Server Subscription Edition + Specifies that copies of the databases on the replicas in the availability group will not be deleted. Otherwise, those database copies will be dropped. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -ProcessAllDatabases -Removes all databases from the current SharePoint farm into the availability group. + +> Applicable: SharePoint Server Subscription Edition + +Removes all databases from the current SharePoint farm into the availability group. ```yaml Type: SwitchParameter Parameter Sets: AllDatabases -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDeletedSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDeletedSite.md index 78d82ef4b..333087129 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDeletedSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDeletedSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a deleted site collection. - ## SYNTAX ``` @@ -33,28 +32,28 @@ For additional information about a server-relative URL or understanding general For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPDeletedSite -Identity 610857cb-8414-4a89-8bf3-ad3628f6c86c ``` This example permanently removes a specific deleted site collection by using a site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the deleted site collection to permanently delete. The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -75,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -86,6 +87,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -93,7 +97,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the content database from which to list site collections. The type must be a valid database name in the form SPContentDB01 or a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -110,8 +116,7 @@ The type must be a valid database name in the form SPContentDB01 or a valid GUID ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -128,8 +136,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -146,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDiagnosticsPerformanceCounter.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDiagnosticsPerformanceCounter.md index 70de8a06f..af6cf8e77 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDiagnosticsPerformanceCounter.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDiagnosticsPerformanceCounter.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes an instance of a performance counter. - ## SYNTAX ``` @@ -31,36 +30,35 @@ There is no user interface. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Remove-SPDiagnosticsPerformanceCounter -category ASP.NET ``` This example removes all the counters in the category ASP.NET on front end Web servers. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Remove-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued" ``` This example removes the counters in the category ASP.NET that have requests queued on front end Web servers. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Remove-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserver ``` This example removes the counters of the _Total instance, with the counter % Processor Time in the category Processor on database servers. - ## PARAMETERS ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies the category of performance counters to remove. The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor. @@ -68,8 +66,7 @@ The type must be a valid name of a category of performance counters; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -79,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,6 +119,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of counter to remove. If this parameter is not specified, this cmdlet removes all performance counters of the specified category. @@ -127,8 +131,7 @@ Disk Queue Length, and % Processor Time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,13 +141,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Removes the specified performance counters that are collected on the database servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,6 +159,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: SharePoint Server Subscription Edition + Specifies the instance name of the performance counter to remove. If this parameter is not specified, this cmdlet removes all instances of the specified performance counter. @@ -162,8 +170,7 @@ The type must be a valid name of a performance counter instance; for example Tot ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,13 +180,15 @@ Accept wildcard characters: False ``` ### -WebFrontEnd + +> Applicable: SharePoint Server Subscription Edition + Removes performance counters that are collected on the front end Web servers in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -189,6 +198,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -196,7 +208,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDistributedCacheServiceInstance.md index cd9cf3e10..b701a073a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPDistributedCacheServiceInstance.md @@ -23,10 +23,9 @@ Use the Remove-SPDistributedCacheServiceInstance cmdlet to remove an instance of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPDistributedCacheServiceInstance ``` @@ -36,16 +35,17 @@ This example removes an instance of a distributed cache. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchComponent.md index 165c97fec..9e25e83b5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchComponent.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the specified search component from the given search topology. - ## SYNTAX ``` @@ -26,10 +25,9 @@ This cmdlet removes the specified search component from an inactive search topol For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e @@ -38,17 +36,18 @@ Remove-SPEnterpriseSearchComponent -SearchTopology $topology -Identity c1642176- This example removes the search component with identity c1642176-b9ae-4096-834c-080da5fba90e from the search topology with identity 10fa59cb-4b32-4fe6-8f8d-065388df201e from the default search application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity for a search component ```yaml Type: SearchComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,14 +57,15 @@ Accept wildcard characters: False ``` ### -SearchTopology -Specifies the search topology from which to retrieve the search component/search components. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search topology from which to retrieve the search component/search components. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,14 +118,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the search topology and search component/search components. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search service application that contains the search topology and search component/search components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md index 579c210a7..dfc602b4c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the current content enrichment configuration from the search service application. - ## SYNTAX ``` @@ -25,10 +24,9 @@ This cmdlet removes the current content enrichment configuration from the Search For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa @@ -36,17 +34,18 @@ Remove-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa This example removes the content enrichment configuration from the default search service application. - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SearchServiceApplication that contains content enrichment configuration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,14 +55,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlContentSource.md index dddc92c13..90e75d9f6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlContentSource.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a specified crawl content source from a search application. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Remove-SPEnterpriseSearchCrawlContentSource` cmdlet deletes a specified cra For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $topo = Get-SPEnterpriseSearchCrawlTopology -SearchApplication $searchapp @@ -42,10 +40,12 @@ $newtopo | Set-SPEnterpriseSearchCrawlTopology -Active This example creates a new, inactive, crawl topology, removes a crawl component from it and activates the new crawl topology. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The crawl content source to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -106,8 +112,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlCustomConnector.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlCustomConnector.md index eb7bd331c..5330e6b51 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlCustomConnector.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlCustomConnector.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a CustomConnector object. - ## SYNTAX ``` @@ -26,28 +25,28 @@ The `Get-SPEnterpriseSearchCrawlCustomConnector` selects the custom connector or For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchCrawlCustomConnector -SearchApplication MySearchServiceApp" - Identity "dctm://" | Remove-SPEnterpriseSearchCrawlCustomConnector ``` This example removes a custom connector for the dctm:// protocol from the MySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the CustomConnector object to remove. The Identity parameter must be an instance of a valid CustomConnector object. ```yaml Type: SPCustomConnectorPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -64,8 +66,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -82,7 +86,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -92,6 +95,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +105,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplicationobject. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlDatabase.md index 16d0fe0ab..85c51b954 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a crawl database. - ## SYNTAX ``` @@ -27,10 +26,9 @@ A crawl database stores crawl history for a search service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPEnterpriseSearchCrawlDatabase -Identity CrawlDB-0 -SearchApplication mySearchServiceApp @@ -38,10 +36,12 @@ Remove-SPEnterpriseSearchCrawlDatabase -Identity CrawlDB-0 This example removes the CrawlDB-0 crawl database from the mySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl database to delete. A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. @@ -49,8 +49,7 @@ A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 1 ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl database collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -106,8 +112,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlExtension.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlExtension.md index 9168ee714..7c723789e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlExtension.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlExtension.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a file name extension from the list of files that can be crawled. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Remove-SPEnterpriseSearchCrawlExtension` cmdlet prevents files with this ex For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $searchapp | Get-SPEnterpriseSearchCrawlExtension "pdf" | Remove-SPEnterpriseSearchCrawlExtension @@ -37,10 +35,12 @@ $searchapp | Get-SPEnterpriseSearchCrawlExtension "pdf" | Remove-SPEnterpriseSea This example removes the PDF IFilter and removes the pdf file extension from the list of file types to include in the content index. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The file name extension to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid file name extension (for example, .xml); or an instance of a valid CrawlExtension object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ExtensionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +68,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the extension collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -101,8 +107,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlLogReadPermission.md index 54cc652cb..6dbd49c05 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlLogReadPermission.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes permission to view crawl log information. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The administrator can choose to restrict this removal to a particular tenant. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" @@ -42,10 +40,12 @@ Remove-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -U This example removes user1 and user2 from the list of users referenced by $crawlLogPermission. $crawlLogPermission is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -53,8 +53,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -71,7 +73,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -81,13 +82,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl log permissions list from which to remove the user(s). ```yaml Type: CrawlLogReadPermissionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,14 +100,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl log. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,14 +119,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies the tenant for which the user permissions shall be removed. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -UserNames + +> Applicable: SharePoint Server Subscription Edition + Specifies the user names that shall no longer have permission to view the crawl log information. Separate names with semi-colons. @@ -141,8 +151,7 @@ When adding several user names, separate names with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlMapping.md index 8d557bdb9..e667d5b6c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a crawl mapping. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Remove-SPEnterpriseSearchCrawlMapping` cmdlet deletes a crawl mapping from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchapp = Get-SPEnterpriseSearchServiceApplication "Sample Search Service Application" $mappingtodelete = Get-SPEnterpriseSearchCrawlContentSource -Identity "somemapping" @@ -38,10 +36,12 @@ mappingtodelete | Remove-SPEnterpriseSearchCrawlMapping This example removes a crawl mapping from a search application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The crawl mapping to delete. A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid CrawlMapping object. @@ -49,8 +49,7 @@ A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in ```yaml Type: CrawlMappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -67,8 +69,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl mapping collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -102,8 +108,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlRule.md index 17f2898df..50a89c9ef 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchCrawlRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a crawl rule. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Remove-SPEnterpriseSearchCrawlRule` cmdlet deletes a crawl rule that is use For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp Remove-SPEnterpriseSearchCrawlRule -Identity https://mySPSite -SearchApplication $searchApp @@ -37,10 +35,12 @@ Remove-SPEnterpriseSearchCrawlRule -Identity https://mySPSite -SearchApplication This example removes a crawl rule pertaining to the path https://mySPSite from the mySearchServiceApp search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The crawl rule to delete. A valid crawl rule URL, such as https://server_name, or an instance of a valid CrawlRule object. @@ -48,8 +48,7 @@ A valid crawl rule URL, such as https://server_name, or an instance of a valid C ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -66,8 +68,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + The search application that contains the crawl rule collection. A valid search application name, such as SearchApp1, or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SearchServiceApplication object. @@ -101,8 +107,7 @@ A valid search application name, such as SearchApp1, or a valid GUID, such as 12 ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchFileFormat.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchFileFormat.md index 88b0d4550..ca76d1788 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchFileFormat.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchFileFormat.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes support for parsing a file format. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Afterwards the search parsing system will stop parsing the file format. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity foo @@ -39,18 +37,18 @@ Remove-SPEnterpriseSearchFileFormat -SearchApplication $ssa -Identity foo This example uses the `Remove-SPEnterpriseSearchFileFormat` cmdlet to remove the file format with the belonging file name extension foo in the search service application referenced by $ssa. - ## PARAMETERS ### -Identity -Specifies the identification of the format to be removed. +> Applicable: SharePoint Server Subscription Edition + +Specifies the identification of the format to be removed. ```yaml Type: DocumentParserFileFormatPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,14 +58,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the file format. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search service application that contains the file format. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -84,8 +86,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +106,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +125,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLanguageResourcePhrase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLanguageResourcePhrase.md index f74d0bae5..d87c9f810 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLanguageResourcePhrase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLanguageResourcePhrase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a language resource phrase from a shared search application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The `Remove-SPEnterpriseSearchLanguageResourcePhrase` cmdlet deletes one or more For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1" $obsoletephrase = Get-SPEnterpriseSearchLanguageResourcePhrase -SearchApplication $searchapp -Language en-us -Type QuerySuggestionBlockList -Identity secret @@ -39,20 +37,20 @@ $obsoletephrase | Remove-SPEnterpriseSearchLanguageResourcePhrase -SearchApplica This example removes a language resource item on the QuerySuggestionBlockList for the en-us language. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,15 +60,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,16 +79,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The language resource phrase to delete. The type must be a string; a valid name of a language resource phrase (for example, LanguageResourcePhrase1); or an instance of a valid LanguageResourcePhrase object. - ```yaml Type: LanguageResourcePhrasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,16 +99,17 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Deletes phrases of the specified language only. The type must be a valid name of a language; for example, en_us. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,17 +119,18 @@ Accept wildcard characters: False ``` ### -Mapping + +> Applicable: SharePoint Server Subscription Edition + Allows a term or phrase to be mapped to another term or phrase. For example, the nickname "John" could be mapped to "Jonathan". This parameter only applies to nicknames and substitutions. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +140,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: @@ -150,12 +155,10 @@ The owner must be one of the following valid levels: - Site - ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -165,16 +168,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the language resources. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,14 +188,15 @@ Accept wildcard characters: False ``` ### -SourceId -Identifies the search result source for which the LanguageResourcePhrase applies to. +> Applicable: SharePoint Server Subscription Edition + +Identifies the search result source for which the LanguageResourcePhrase applies to. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +206,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Constrains to delete phrases of specified type. The type must be one of the following valid types of phrases: @@ -213,12 +221,10 @@ The type must be one of the following valid types of phrases: - QuerySuggestionSubstitution - ```yaml Type: LanguageResourceType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -228,15 +234,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLinksDatabase.md index 424e15aeb..f270e9da1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchLinksDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a links database. - ## SYNTAX ``` @@ -27,10 +26,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $linksDatabase = $ssa | Get-SPEnterpriseSearchLinksDatabase Links2 @@ -40,18 +38,19 @@ Remove-SPEnterpriseSearchLinksDatabase -Identity $linksDatabase This example removes the links database referenced by $linksDatabase. $linksDatabase is the identity of the links database Links2 on the search service application referenced by $ssa. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the links database to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -68,8 +70,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,14 +99,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataCategory.md index 82bd4df10..ff00aafd8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataCategory.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a crawled property category. - ## SYNTAX ``` @@ -27,21 +26,22 @@ You should use this cmdlet after a crawl to delete unused or unwanted categories For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell -$searchapp = Get-SPEnterpriseSearchServiceApplication +$searchapp = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchMetadataCategory -Identity MyCategory -SearchApplication $searchapp ``` This example removes the metadata category named MyCategory for the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata category to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. @@ -51,8 +51,7 @@ Note that if only a name for a category is specified, a SearchApplication must a ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the enterprise search metadata property schema. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -108,8 +114,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataManagedProperty.md index 9fc7024a4..aeee1726c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataManagedProperty.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a metadata managed property. - ## SYNTAX ``` @@ -27,22 +26,23 @@ This cmdlet deletes a specified managed property from the managed property colle For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell -$searchapp = Get-SPEnterpriseSearchServiceApplication -$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity AboutMeUpdate +$searchapp = Get-SPEnterpriseSearchServiceApplication +$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity AboutMeUpdate Remove-SPEnterpriseSearchMetadataManagedProperty -Identity $mp ``` This example removes the managed property AboutMeUpdate from the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to delete. The type must be a valid name of a managed property, for example ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -52,8 +52,7 @@ Note that if only a name of a managed property is specified, a SearchApplication ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -70,8 +72,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -105,8 +111,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -123,8 +131,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -141,8 +151,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataMapping.md index 7f0236ffe..fbc3b211c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchMetadataMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a metadata mapping from a managed property. - ## SYNTAX ``` @@ -27,14 +26,13 @@ A metadata mapping is the mapping between a managed property and one or more cra For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $searchapp = Get-SPEnterpriseSearchServiceApplication -$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People -$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1 +$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People +$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1 $mycp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name "MyCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType $mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity UserName New-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $mp -CrawledProperty $mycp @@ -45,10 +43,12 @@ Remove-SPEnterpriseSearchMetadataMapping -Identity $map -confirm:$false This example removes an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `Set-SPEnterpriseSearchMetadataMapping`) for the default search service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata mapping to delete. The type must be a valid URL, in the form https://server_name, or an instance of a valid Mapping object. @@ -56,8 +56,7 @@ The type must be a valid URL, in the form https://server_name, or an instance of ```yaml Type: MappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,14 +66,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -108,8 +114,7 @@ The type must be a valid search application name, for example, SearchApp1, or an ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryAuthority.md index aaf9a8a59..869ed3a24 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes an authoritative page. - ## SYNTAX ``` @@ -27,20 +26,21 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPEnterpriseSearchQueryAuthority -Identity https://contoso.com -SearchApplication MySSA ``` This example removes the query authority URL https://contoso.com from the search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the query authority page to delete. The type must be a valid URL, in the form https://server_name; or an instance a valid AuthorityPage object. @@ -48,8 +48,7 @@ The type must be a valid URL, in the form https://server_name; or an instance a ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Query Authority is created.The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the authoritative page collection to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -121,8 +129,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryDemoted.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryDemoted.md index a4bee9538..67937460d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryDemoted.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryDemoted.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a demoted site rule. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Query demoted sites are de-emphasized in relevance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $demotedRule = Get-SPEnterpriseSearchQueryDemoted -Identity https://somesite.com -SearchApplication MySSA $demotedRule | Remove-SPEnterpriseSearchQueryDemoted @@ -38,10 +36,12 @@ $demotedRule | Remove-SPEnterpriseSearchQueryDemoted This example obtains a reference to a site demotion rule for the URL https://somesite.com and removes it. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the demoted site rule to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid Demoted object. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: DemotedPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the corresponding Demoted object is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -83,8 +87,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the demoted site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -118,8 +126,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryKeyword.md index 54f3e0a52..2ad85182c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryKeyword.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a query keyword. - ## SYNTAX ``` @@ -27,20 +26,21 @@ You cannot use this cmdlet after a site collection is upgraded to SharePoint Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Remove-SPEnterpriseSearchQueryKeyword -Site https://myserver/sites/engineering ``` This example removes the Engineering keyword from the site collection at https://myserver/sites/engineering. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the keyword term to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Filters to delete keywords from the specified site collection of results. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -66,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScope.md index 3a6732dc3..5c5891b3a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScope.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a query scope. - ## SYNTAX ``` @@ -34,10 +33,9 @@ A query scope represents a query results scope used by all shared search applica For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPenterpriseSearchServiceApplication -Identity MySSA Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Remove-SPEnterpriseSearchQueryScope @@ -45,10 +43,12 @@ Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | R This example removes a scope named MustCrawl from a search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the query scope to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -56,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +76,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope collection. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -109,8 +115,7 @@ The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Filters to delete scopes of the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -128,7 +136,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScopeRule.md index acf0f9bcf..e5c76ae0a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchQueryScopeRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes query results scope rules. - ## SYNTAX ``` @@ -33,10 +32,9 @@ The `Remove-SPEnterpriseSearchQueryScopeRule` cmdlet deletes one or more shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "MySSA" $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -45,10 +43,12 @@ Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url https://criticalSite | R This example removes a scope rule for the URL https://criticalSite from a search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope rule to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance of a valid ScopeRule object. @@ -56,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Filters to delete query scope rules for the specified results URL. The type must be a valid URL, in the form https://server_name. @@ -75,7 +77,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -92,8 +96,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Filters to delete multiple rules for a specified scope. The type must be a valid string that identifies the scope; for example, Scope1. @@ -128,7 +136,6 @@ The type must be a valid string that identifies the scope; for example, Scope1. Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -145,8 +155,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchRankingModel.md index b8ade25fd..ad93a9dc0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchRankingModel.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a ranking model. - ## SYNTAX ``` @@ -26,10 +25,9 @@ This cmdlet deletes a specified ranking model. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level ssa @@ -38,8 +36,7 @@ Remove-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e0 This example removes the ranking model for the search service application with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $owner = Get-SPEnterpriseSearchOwner -Level ssa $MyRanking = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" | Get-SPEnterpriseSearchRankingModel -Owner $owner @@ -48,10 +45,12 @@ Remove-SPEnterpriseSearchRankingModel -Identity $MyRanking -Owner $owner This example removes the ranking model object MyRanking from the search service application Search Service Application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ranking model to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. @@ -59,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +68,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -78,7 +79,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,14 +88,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -105,6 +107,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -112,7 +117,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,6 +126,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the ranking model. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -129,8 +136,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultItemType.md index c8821edaf..5ada2cba4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultItemType.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a result item type for a search object owner. - ## SYNTAX ``` @@ -26,7 +25,7 @@ Remove-SPEnterpriseSearchResultItemType [-Identity] -Ow The `Remove-SPEnterpriseSearchResultItemType` cmdlet removes a user-created result item type, given a result type identity and a search owner. You cannot use this cmdlet to remove the built-in result item types that are included with SharePoint products. -Result item types enable you to change the look of search results based on the type of result. +Result item types enable you to change the look of search results based on the type of result. You start by defining a collection of rules, which will be evaluated against the properties of results. Then you define the display template to use for rendering that type of result. Once you have created the result item type, results matching the rules of the result item type will display using the specified display template. @@ -43,10 +42,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $web = Get-SPWeb "UrlOfTheSite" $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web @@ -63,14 +61,16 @@ Next, the example removes the result item type referenced by $resultType for the ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -80,13 +80,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the result item type is created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -96,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -103,8 +108,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -131,14 +137,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,14 +156,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -165,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultSource.md index db529eecd..4c86cddf7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchResultSource.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a result source. - ## SYNTAX ``` @@ -24,13 +23,12 @@ Remove-SPEnterpriseSearchResultSource [-Identity] -Owner ## DESCRIPTION This cmdlet deletes a specified result source. This cmdlet supports the same delete operations as are supported through the "Manage Result Sources" page in Central Administration. -The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true). +The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true). For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -39,8 +37,7 @@ Remove-SPEnterpriseSearchResultSource -Identity "Custom SharePoint Result Source This example deletes the search service application level result source with the name "Custom SharePoint Result Source". - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -49,8 +46,7 @@ Remove-SPEnterpriseSearchResultSource -Identity 12345678-90ab-cdef-1234-567890bc This example deletes the search service application level result source with the id 12345678-90ab-cdef-1234-567890bcdefgh. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -60,20 +56,20 @@ Remove-SPEnterpriseSearchResultSource -Identity $resultSource -SearchApplication This example deletes the search service application level result source with the name "Custom SharePoint Result Source", by specifying a Source instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result source to delete. The result source cannot be a built in source. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -83,14 +79,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -100,15 +97,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,16 +116,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,6 +136,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -154,6 +155,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -161,7 +165,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSecurityTrimmer.md index aca56b50a..91cdc1996 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSecurityTrimmer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a custom security trimmer. - ## SYNTAX ``` @@ -27,20 +26,21 @@ A custom security trimmer trims search results before the results are returned t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchSecurityTrimmer -SearchApplication MySSA | Remove-SPEnterpriseSearchSecurityTrimmer ``` This example removes the security trimmer registered in the search service application named MySSA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the security trimmer to delete. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid SecurityTrimmer object. @@ -48,8 +48,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SecurityTrimmerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the security trimmer. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -66,8 +68,7 @@ The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplication.md index ff36f652c..ec9b9049f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a search service application. - ## SYNTAX ``` @@ -25,20 +24,21 @@ This cmdlet deletes a specified SearchServiceApplication from a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPEnterpriseSearchServiceApplication -Identity MySSA ``` This example removes the search service application named MySSA from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to delete. A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -46,8 +46,7 @@ A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid sear ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server Subscription Edition + Specifies that all search databases and index files associated with the search service application to be deleted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationProxy.md index b91002cb7..dbb59f1bd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a search service application proxy. - ## SYNTAX ``` @@ -25,20 +24,21 @@ This cmdlet deletes the specified search service application proxy from a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPEnterpriseSearchServiceApplicationProxy -Identity SearchProxy ``` This example removes a search service application proxy named SearchProxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application proxy to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, ServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md index 92aca7be1..a94a344eb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchServiceApplicationSiteSettings.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Cleans up search settings for a particular site collection, subscription, or search application. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the `Remove-SPEnterpriseSearchServiceApplicationSiteSettings` cmdlet to remo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $app = Get-SPEnterpriseSearchServiceApplication $GC = Start-SPAssignment @@ -41,18 +39,19 @@ Stop-SPAssignment $GC This example removes the search settings for the site collection referenced by $s in the search application referenced by $app. $s is the site collection with URL "UrlOfSiteCollection" and $s.ID.ToString() is the string representation of the site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection to remove search settings from. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SiteSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,14 +61,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,14 +80,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,14 +118,16 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: SharePoint Server Subscription Edition + Specifies the tenant from which to remove search settings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSiteHitRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSiteHitRule.md index 13662bfc2..637835c3e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSiteHitRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchSiteHitRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a site hit rule. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Remove-SPEnterpriseSearchSiteHitRule` cmdlet deletes the site hit rule that For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------- +### EXAMPLE ```powershell Remove-SPEnterpriseSearchSiteHitRule -Identity myHost ``` This example removes a site hit rule for the myHost host. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The rule that is used for the specified site. The type must be a valid site hit rule host or an instance of a valid SiteHitRule object. @@ -47,8 +47,7 @@ The type must be a valid site hit rule host or an instance of a valid SiteHitRul ```yaml Type: SiteHitRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -65,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -83,7 +87,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -SearchService + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service in the farm that hosts the crawl. The type must be an instance of a valid SearchService object; otherwise, the local service on the server that hosts the Windows PowerShell cmdlet is used. @@ -100,8 +106,7 @@ The type must be an instance of a valid SearchService object; otherwise, the loc ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantConfiguration.md index 913386104..30494233e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes all tenant specific search settings. - ## SYNTAX ``` @@ -29,10 +28,9 @@ When moving a tenant, copy the tenant configuration from the source to the desti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000-0000-0000-000000000001" -SearchApplication $ssa @@ -40,10 +38,12 @@ Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000- This example uses Remove-SPEnterpriseSearchTenantConfiguration to remove all tenant specific settings from the search service application referenced by $ssa. - ## PARAMETERS ### -SiteSubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription of the tenant. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -51,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: Guid Parameter Sets: (All) Aliases: Identity -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -61,14 +60,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application that contains the tenant configuration. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -85,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantSchema.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantSchema.md index bc46aa11e..01542dc20 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantSchema.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTenantSchema.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a defined search schema. - ## SYNTAX ``` @@ -23,15 +22,14 @@ Remove-SPEnterpriseSearchTenantSchema [-Identity] ``` ## DESCRIPTION -This cmdlet removes a search schema. +This cmdlet removes a search schema. Use this cmdlet to remove an unused or unwanted search schema. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication [Guid]$guid = "909b84cb-90f2-4a1b-8df4-22547a9b2227" @@ -40,10 +38,12 @@ Remove-SPEnterpriseSearchTenantSchema -Identity $guid -SearchApplication $ssa This example removes the search schema for the tenant with GUID 909b84cb-90f2-4a1b-8df4-22547a9b2227. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the tenant of the search schema to be removed. The type must be a valid GUID, in string form, that identifies the tenant in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -53,8 +53,7 @@ The tenant GUID can be found in the Search Service Application database, in the ```yaml Type: TenantSchemaPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the enterprise search schema to be removed. The type must be a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -106,8 +112,7 @@ The type must be a valid search application name (for example, SearchApp1), or a ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the search schema to be removed is within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -124,8 +132,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTopology.md index 54d7e1e3e..4ae277242 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPEnterpriseSearchTopology.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes an inactive search topology from a search service application. - ## SYNTAX ``` @@ -26,10 +25,9 @@ This cmdlet removes the given inactive search topology from the search service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 4b32-4fe6-8f8d-065388df201e @@ -38,8 +36,7 @@ Remove-SPEnterpriseSearchTopology -Identity $topology This example removes a search topology with the identity 4b32-4fe6-8f8d-065388df201e. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Remove-SPEnterpriseSearchTopology -Identity $topo -SearchApplication $ssa @@ -47,17 +44,18 @@ Remove-SPEnterpriseSearchTopology -Identity $topo -SearchApplication $ssa This example removes the search topology referenced by $topo in the search service application referenced by $ssa. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology to retrieve. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -74,8 +75,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which the search topology belongs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -109,8 +114,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPInfoPathUserAgent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPInfoPathUserAgent.md index 4f536eb36..fcae89ac3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPInfoPathUserAgent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPInfoPathUserAgent.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a user agent. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPIPUserAgent` cmdlet removes a specified user agent from the user a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPInfoPathUserAgent -Identity "UserAgentName" ``` This example removes a user agent. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the user agent to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user agent (for example, UserAgent1; or an instance of a valid SPUserAgent object. @@ -47,7 +47,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPUserAgentPipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedAccount.md index 76cf8ba02..b8e750e24 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedAccount.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a managed account registration from the farm. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Remove-SPManagedAccount` cmdlet removes account registration from the confi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE------------------- +### EXAMPLE ```powershell Remove-SPManagedAccount -Identity DOMAIN\ServiceAcct ``` This example removes the DOMAIN\ServiceAcct managed account from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -50,8 +50,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: SharePoint Server Subscription Edition + Specifies a secure string for the new password (that is, $MySecureString). Works in conjunction with the ChangePassword parameter. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -ChangePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies whether a password is to be changed. Works in conjunction with the NewPassword parameter. When the ChangePassword value is set, a secure string value is required for the NewPassword parameter (that is, $MySecureString). @@ -106,8 +112,7 @@ When the ChangePassword value is set, a secure string value is required for the ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedPath.md index d1db2c3ae..c50ddc07f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPManagedPath.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes the specified managed path from the specified host header or Web application. - ## SYNTAX ### HostHeader @@ -41,10 +40,9 @@ Otherwise, you must specify the Web application that contains the managed path t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------------- +### EXAMPLE 1 ```powershell Remove-SPManagedPath "sites" -HostHeader ``` @@ -53,8 +51,7 @@ This example removes the sites managed path from the list of host-named site col Depending on the confirmation level of the local system, the preceding example can prompt prior to execution. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$false ``` @@ -62,18 +59,19 @@ Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$false This example removes the personal managed path from all Web applications in the farm. This command does not prompt for confirmation. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the managed path to delete. For example, in the URL https://sitename/sites/site1, "sites" is the name of the managed path. ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -83,13 +81,15 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Identity is a host header managed path. ```yaml Type: SwitchParameter Parameter Sets: HostHeader -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,14 +99,16 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web application that hosts the managed path to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name, in the form WebApp2423. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -116,6 +118,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +132,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -155,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPODataConnectionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPODataConnectionSetting.md index c80bc1d90..c6d6685ca 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPODataConnectionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPODataConnectionSetting.md @@ -32,7 +32,7 @@ Remove-SPODataConnectionSetting -ServiceContext ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell {{ Add example code here }} ``` @@ -42,6 +42,9 @@ Remove-SPODataConnectionSetting -ServiceContext ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,7 +57,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Identity Description }} ```yaml Type: ODataConnectionSettings Parameter Sets: Identity Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 0 @@ -80,13 +84,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Name Description }} ```yaml Type: String Parameter Sets: Name Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -96,13 +102,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceContext Description }} ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -112,13 +120,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -135,7 +148,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerDistributionListSearchDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerDistributionListSearchDomain.md index db7723875..27e8aed49 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerDistributionListSearchDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerDistributionListSearchDomain.md @@ -26,7 +26,7 @@ This Remove-SPPeoplePickerDistributionListSearchDomain cmdlet removes a domain f ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Remove-SPPeoplePickerDistributionListSearchDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" ``` @@ -36,6 +36,9 @@ This example removes domain "corp.contoso.com" from the distribution list search ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,7 +51,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + The domain name to remove from the list. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to modify the distribution list search domain list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -90,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -97,7 +106,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +125,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerSearchADDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerSearchADDomain.md index c98e2898b..3d6f6dddf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerSearchADDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerSearchADDomain.md @@ -25,14 +25,14 @@ This Remove-SPPeoplePickerSearchADDomain cmdlet removes a forest or domain with ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Remove-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -IsForest ``` This example removes forest corp.contoso.com from the People Picker search Active Directory domain list of the Web application MyOfficeApp1. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Remove-SPPeoplePickerSearchADDomain -WebApplication http://MyOfficeApp1 -DomainName "corp.contoso.com" -UserName "contoso\user" ``` @@ -42,6 +42,9 @@ This example removes domain corp.contoso.com from the People Picker search Activ ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,7 +57,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: SharePoint Server Subscription Edition + Name of the domain or forest. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -80,6 +84,9 @@ Accept wildcard characters: False ``` ### -IsForest + +> Applicable: SharePoint Server Subscription Edition + Specifies that the name specified by the DomainName parameter is an Active Directory forest. If the IsForest parameter is omitted, the name specified by the DomainName parameter is treated as an Active Directory domain. @@ -87,7 +94,6 @@ If the IsForest parameter is omitted, the name specified by the DomainName param Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: SharePoint Server Subscription Edition + The login name of the forest or domain. If this is not specified, it will match domains with empty login name. @@ -105,7 +114,6 @@ If this is not specified, it will match domains with empty login name. Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,13 +123,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to remove the People Picker forest/domain settings from. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -131,6 +141,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -138,7 +151,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -155,7 +170,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerServiceAccountDirectoryPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerServiceAccountDirectoryPath.md index 136922b12..b9ec77f05 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerServiceAccountDirectoryPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPeoplePickerServiceAccountDirectoryPath.md @@ -27,7 +27,7 @@ This Remove-SPPeoplePickerServiceAccountDirectoryPath cmdlet removes an OU from ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Remove-SPPeoplePickerServiceAccountDirectoryPath -WebApplication http://MyOfficeApp1 -OUName "OU=FarmAdmin,DC=Contoso,DC=local" ``` @@ -37,6 +37,9 @@ This example removes OU "FarmAdmin" from the service account directory path list ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,7 +52,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -OrganizationalUnitName + +> Applicable: SharePoint Server Subscription Edition + {{ Fill OrganizationalUnitName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to modify the service account directory path list to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters @@ -98,7 +107,6 @@ For more information, type the following command: get-help about_commonparameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -108,6 +116,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -115,7 +126,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPluggableSecurityTrimmer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPluggableSecurityTrimmer.md index 8e839ee54..d92952d88 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPluggableSecurityTrimmer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPPluggableSecurityTrimmer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a pluggable security trimmer from a profile service application proxy. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPPluggableSecurityTrimmer` cmdlet to remove a specified pluggab For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell $pr = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInId 0 @@ -36,8 +34,7 @@ Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInI This example removes a pluggable security trimmer. - -### -----------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0 @@ -45,10 +42,12 @@ Remove-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -Plug This example turns off security trimming in a User Profile Service Application. - ## PARAMETERS ### -UserProfileApplicationProxyId + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the User Profile service application proxy from which the pluggable security trimmer is removed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -56,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,13 +65,15 @@ Accept wildcard characters: False ``` ### -PlugInId + +> Applicable: SharePoint Server Subscription Edition + The index of the pluggable security trimmer must have an integer value greater than or equal to zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -90,8 +93,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +103,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileLeader.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileLeader.md index 484bca74b..1f050f2b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileLeader.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileLeader.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Remove a company leader. - ## SYNTAX ``` @@ -30,10 +29,9 @@ For additional information about SPProfileLeader cmdlets, see The *-SPProfileLea For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPProfileLeader -ProfileServiceApplicationProxy $proxy -Name "contoso\janedow" @@ -41,17 +39,18 @@ Remove-SPProfileLeader -ProfileServiceApplicationProxy $proxy -Name "contoso\jan This example removes the user "Jane Dow" from the leaders list for a specific user profile service application. - ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile Service Application Proxy to use. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,14 +60,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name to be removed as a leader for the new User Profile Service application. For example, Contoso\Joe. ```yaml Type: SPProfileLeaderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -85,8 +89,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,14 +118,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileSyncConnection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileSyncConnection.md index 969838c0b..f53fc547c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileSyncConnection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProfileSyncConnection.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a synchronization connection. - ## SYNTAX ``` @@ -32,27 +31,27 @@ This cmdlet only works with Active Directory Synchronization Connections For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPProfileSyncConnection -ProfileServiceApplication 888ds256-9ad9-53a9-f135-99eecd245670b -ConnectionDomain "Fabrikam" -ConnectionUserName "Testupa" -ConnectionPassword convertto-securestring "Password1" -asplaintext -force -ConnectionSynchronizationOU "OU=SharePoint Users,DC=fabrikam,DC=com" ``` This example removes a user from the fabrikam domain using a specific user profile service application. - ## PARAMETERS ### -ProfileServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the User Profile service application. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -ConnectionDomain + +> Applicable: SharePoint Server Subscription Edition + Specifies the NetBIOS name of the domain you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -ConnectionForestName + +> Applicable: SharePoint Server Subscription Edition + Specifies the forest name you are connecting to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,13 +97,15 @@ Accept wildcard characters: False ``` ### -ConnectionPassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the account used for directory connection. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -110,14 +115,16 @@ Accept wildcard characters: False ``` ### -ConnectionSynchronizationOU + +> Applicable: SharePoint Server Subscription Edition + Specifies the top level organizational unit (OU) that you would like to synchronize. The value must be a domain name and you can only include one container per command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -127,13 +134,15 @@ Accept wildcard characters: False ``` ### -ConnectionUserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to be used for the synchronization connection. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -143,6 +152,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -154,8 +166,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -165,6 +176,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -172,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -182,13 +195,15 @@ Accept wildcard characters: False ``` ### -ConnectionNamingContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the naming context of the directory information tree to connect to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,13 +213,15 @@ Accept wildcard characters: False ``` ### -ConnectionServerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the connection server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -214,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -221,7 +241,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProjectWebInstanceData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProjectWebInstanceData.md index da537e31b..3a8d3c7f8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProjectWebInstanceData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPProjectWebInstanceData.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/remove-spprojectwebinstancedata -Applicable: SharePoint Server Subscription Edition + title: Remove-SPProjectWebInstanceData schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Disassociates a Site Collection with the Project Server instance. - ## SYNTAX ``` @@ -25,17 +24,19 @@ This cmdlet disassociates the Project Server instance from the specified Site Co ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPProjectWebInstanceData -SiteCollection https://contoso/sites/pwa ``` This example disassociates https://contoso/sites/pwa from the Project Server instance. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +54,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + The site collection to disassociate from the Project Server instance. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,6 +90,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +100,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachineInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachineInfo.md index 2158a7c57..9a9f152b8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachineInfo.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes an external routing target. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPRoutingMachineInfo` cmdlet to remove an external routing targe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------EXAMPLE------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -38,17 +36,18 @@ Remove-SPRoutingMachineInfo -Identity $M This example removes a routing target for a specified identity. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the computer object that Request Manager will remove. ```yaml Type: SPRoutingMachineInfoPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachinePool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachinePool.md index dfabf04d5..923341b73 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingMachinePool.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a routing pool from Request Manager. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPRoutingMachinePool` cmdlet to remove a routing pool from the R For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -38,17 +36,18 @@ Remove-SPRoutingMachinePool -Identity $pool This example removes a routing pool for the specified identity by using the $pool variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Request Manager object to remove. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingRule.md index 4512e2ae2..845abd451 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPRoutingRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a routing rule. - ## SYNTAX ``` @@ -26,10 +25,9 @@ If the Identity parameter is not specified, the routing rules for the entire far For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $rm=Get-SPRequestManagementSettings -Identity $web Get-SPRoutingRule -RequestManagementSettings $rm @@ -42,17 +40,18 @@ Remove-SPRoutingRule -Identity $rule This example removes a routing for a specified identity by using the $rule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the rule object to remove. ```yaml Type: SPRoutingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPScaleOutDatabase.md index ac098b07b..5c3db39c5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPScaleOutDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a specific scale-out database. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPScaleOutDatabase` cmdlet to remove a specific scale-out databa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -37,17 +35,18 @@ Remove-SPScaleOutDatabase -ServiceApplication $serviceApplication -Database $dat This example removes the specified scale-out database from the specified service application. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to remove. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application of the scale-out database to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -73,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +88,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -DeleteData + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to delete data when the scale out database is removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -135,7 +145,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreApplication.md index f0859c9cf..7beb72004 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a Secure Store application. - ## SYNTAX ``` @@ -25,27 +24,27 @@ The `Remove-SPSecureStoreApplication` cmdlet deletes a Secure Store application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApp" | Remove-SPSecureStoreApplication ``` This example removes the specified application and target. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Store application to delete. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreSystemAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreSystemAccount.md index cadc26477..f6284ad7c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreSystemAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSecureStoreSystemAccount.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a user account from a designated list. - ## SYNTAX ``` @@ -25,35 +24,34 @@ Use the `Remove-SPSecureStoreSystemAccount` cmdlet to remove a user account from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Remove-SPSecureStoreSystemAccount -Identity contoso\jdoe ``` This example removes a specific user name jdoe by using the Identity parameter. - -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPSecureStoreSystemAccount | Where-Object -filter {$_.AccountName -eq 'Contoso\admin'} | Remove-SPSecureStoreSystemAccount ``` This example removes the admin, user from the contoso domain by filtering the results from the `Get-SPSecureStoreSystemAccount` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, object, or GUID to remove. ```yaml Type: SPSecureStoreSystemAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -92,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServerScaleOutDatabase.md index dabaa2c6b..480a1b8fc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServerScaleOutDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a specific scale-out database. - ## SYNTAX ``` @@ -24,10 +23,9 @@ Remove-SPServerScaleOutDatabase -Database ## DESCRIPTION Use the Remove-SPServerScaleOutDatabase cmdlet to remove a specific scale-out database from a specified service application. - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Managed Metadata Service'} $database = Get-SPServerScaleOutDatabase -ServiceApplication $sa @@ -36,17 +34,18 @@ Remove-SPServerScaleOutDatabase -Database $database -ServiceApplication $sa This example removes the specified scale-out database from the Managed Metadata Service application. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to remove. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application of the scale-out database to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -79,8 +83,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,13 +93,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,13 +111,15 @@ Accept wildcard characters: False ``` ### -DeleteData + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to delete data when the scale out database is removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +129,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -129,7 +139,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplication.md index 2cc80ea9a..9c79d166e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes the specified service application on the local server. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Remove-SPServiceApplication` cmdlet deletes the specified service applicati For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------------- +### EXAMPLE ```powershell Remove-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -RemoveData ``` @@ -38,17 +36,18 @@ This example deletes the service application and its database. The service application GUID is unique to every farm. You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service applications and then use the result from the `Get-SPServiceApplication` cmdlet for other SPServiceApplication cmdlets; for example, or `Publish-SPServiceApplication`. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application to remove. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server Subscription Edition + Deletes all databases and other data associated with the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationPool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationPool.md index fa28d551b..58cf1e565 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationPool.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Completely deletes the specified Web service application pool. - ## SYNTAX ``` @@ -25,27 +24,27 @@ The `Remove-SPServiceApplicationPool` cmdlet completely deletes the specified We For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPServiceApplicationPool TestServiceWebApplicationPool ``` This example deletes the selected service application pool. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web service application pool to delete. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxy.md index e9afbac18..7e7c29067 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes the specified service application proxy. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Remove-SPServiceApplicationProxy` cmdlet deletes the service application pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Remove-SPServiceApplicationProxy $proxy @@ -39,6 +37,9 @@ This example deletes the User Profile Service Application proxy. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application proxy to remove. The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -46,8 +47,7 @@ The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,13 +57,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server Subscription Edition + Deletes all databases and other data associated with the service application proxy. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,6 +75,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -80,7 +85,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -97,7 +104,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -114,8 +123,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroup.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroup.md index fd699ea5a..da3cd4dc5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroup.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroup.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Completely deletes the specified service application proxy group. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Completely deletes the specified service application proxy group. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------------- +### EXAMPLE ```powershell Remove-SPServiceApplicationProxyGroup RemoteProxyGroup ``` @@ -39,17 +37,18 @@ The service application proxy group GUID is unique to every farm. You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The identity of the service application proxy group to delete. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroupMember.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroupMember.md index 56401eb47..5e1a6d5dc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroupMember.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPServiceApplicationProxyGroupMember.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes one or more proxies from the specified service application proxy group. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Remove-SPServiceApplicationProxyGroupMember` cmdlet removes one or more pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member babab30e-8e3a-428b-8ff4-4d5c8f455e6d ``` @@ -40,17 +38,18 @@ The service application proxy group GUID is unique to every farm. You can run `Get-SPServiceApplicationProxyGroup | Select Name,Id` to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the service application proxy group from which to remove the member or members. ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: SharePoint Server Subscription Edition + Specifies the member or members to remove from the service application proxy group. ```yaml Type: SPServiceApplicationProxyPipeBind[] Parameter Sets: (All) Aliases: Proxy -Applicable: SharePoint Server Subscription Edition Required: True Position: 2 @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPShellAdmin.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPShellAdmin.md index 699604382..dc35fdb91 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPShellAdmin.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPShellAdmin.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a user from the SharePoint_Shell_Access role. - ## SYNTAX ``` @@ -32,27 +31,27 @@ When you run this cmdlet to add a user to the SharePoint_Shell_Access role, the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### EXAMPLE ```powershell Remove-SPShellAdmin -UserName CONTOSO\User1 -database 4251d855-3c15-4501-8dd1-98f960359fa6 ``` This example removes an existing user named User1 from the SharePoint_Shell_Access role in the database specified. - ## PARAMETERS ### -UserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the user you want to remove from the SharePoint_Shell_Access role in the specified database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -91,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,14 +104,16 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the database or the Database Object that includes the SharePoint_Shell_Access role from which the user is to be removed. If the database parameter is not specified, the configuration database is used. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSite.md index 5ec38bf17..46857f547 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Completely deletes an existing site collection and all subsites. - ## SYNTAX ``` @@ -25,17 +24,16 @@ Remove-SPSite [-Identity] [-DeleteADAccounts] [-GradualDelete] The **Remove-SPSite** cmdlet completely deletes an existing site collection and all subsites. This operation cannot be undone. - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Remove-SPSite -Identity 'https://sitename' -GradualDelete -Confirm:$False ``` This example removes the given site collection and all included sites by using GradualDelete which places the site in the site recycle bin; confirmation has been suppressed. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Remove-SPSite -Identity 'https://sitename' ``` @@ -45,14 +43,16 @@ This example immediately deletes the site and it's contents from the farm. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the site to delete. The identity can be either a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +62,9 @@ Accept wildcard characters: False ``` ### -DeleteADAccounts + +> Applicable: SharePoint Server Subscription Edition + Forces deletion of user accounts from Active Directory Domain Services (AD DS). This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. @@ -69,7 +72,7 @@ This applies when in AD DS account creation mode and the value of this parameter Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -78,13 +81,16 @@ Accept wildcard characters: False ``` ### -CheckComplianceFlags -Specifies if compliance flags are enabled. + +> Applicable: SharePoint Server Subscription Edition + +Specifies if compliance flags are enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -93,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. @@ -100,8 +109,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,6 +138,9 @@ Accept wildcard characters: False ``` ### -DeleteADAccounts + +> Applicable: SharePoint Server Subscription Edition + Forces deletion of user accounts from Active Directory Domain Services (AD DS). This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS. @@ -135,8 +148,7 @@ This applies when in AD DS account creation mode and the value of this parameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +158,9 @@ Accept wildcard characters: False ``` ### -GradualDelete + +> Applicable: SharePoint Server Subscription Edition + If provided, occurs gradually to use less system load. This operation is strongly recommended for deleting very large sites. This option places the site in the site recycle bin instead of immediately deleting the site. @@ -153,8 +168,7 @@ This operation is strongly recommended for deleting very large sites. This optio ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -171,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteMaster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteMaster.md index ae847a249..629a59246 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteMaster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteMaster.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/remove-spsitemaster -Applicable: SharePoint Server Subscription Edition + title: Remove-SPSiteMaster schema: 2.0.0 --- @@ -22,7 +22,7 @@ Remove-SPSiteMaster [-ContentDatabase] [-SiteId] Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +43,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,13 +53,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -68,13 +71,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to remove the site master. For example, WSS_Content. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -SiteId + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the Site Master to remove. For example, ff480534-7e64-44a5-b7e3-7c418624cdf6. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -100,6 +107,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -107,7 +117,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscription.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscription.md index e77590f14..94aca31c9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscription.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscription.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes data stored in a subscription settings service application for a set of site subscriptions. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPSiteSubscription` cmdlet removes a site subscription along with al For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPSiteSubscription "https://contoso.com" ``` This example removes all data for the contoso.com site subscription (site collections, site subscription and settings). - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription settings service application that contains the service data to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the removal of a site subscription and is the only way to stop this command from prompting for confirmation. The type must be either of the following values: @@ -108,8 +114,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md index 95449fc60..b65b7620f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionBusinessDataCatalogConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the Business Data Connectivity Metadata Store for a partition. - ## SYNTAX ``` @@ -26,20 +25,21 @@ To completely remove a partition and the data that it contains, run the `Clear-S For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso ``` This example removes the Business Data Connectivity Metadata Store for the partition http://contoso. - ## PARAMETERS ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context of the Business Data Connectivity Metadata Store to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePack.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePack.md index 729d5879e..8e31e811c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePack.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a SharePoint Feature set from a site subscription. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPSiteSubscriptionFeaturePack` cmdlet removes a SharePoint Feature s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE------------------------ +### EXAMPLE ```powershell Remove-SPFeatureSet -Identity "30daa535-b0fe-4d10-84b0-fb04029d161a" ``` This example removes a SharePoint Feature set that has the ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Feature set object to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePackMember.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePackMember.md index 2e78871ba..0c75627c5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePackMember.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionFeaturePackMember.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a feature definition from the provided SharePoint Feature set. - ## SYNTAX ### AllFeatureDefinitions @@ -39,10 +38,9 @@ If the AllFeatureDefinitions flag is provided, all feature definitions are remov For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell $FS = Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" Remove-SPSiteSubscriptionFeaturePackMember -Identity $fs -FeatureDefinition (Get-SPFeature "PublishingSite") @@ -50,18 +48,19 @@ Remove-SPSiteSubscriptionFeaturePackMember -Identity $fs -FeatureDefinition (Get This example removes the PublishingSite feature from the Feature set that has ID 30daa535-b0fe-4d10-84b0-fb04029d161a. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" | Remove-SPSiteSubscriptionFeaturePackMember -AllFeatureDefinitions ``` This example removes all features from the Feature set 30daa535-b0fe-4d10-84b0-fb04029d161a. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Feature set from which to remove a feature. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object. @@ -69,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -80,13 +78,15 @@ Accept wildcard characters: False ``` ### -AllFeatureDefinitions + +> Applicable: SharePoint Server Subscription Edition + Clears all features from the Feature set. ```yaml Type: SwitchParameter Parameter Sets: AllFeatureDefinitions -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -96,13 +96,15 @@ Accept wildcard characters: False ``` ### -FeatureDefinition + +> Applicable: SharePoint Server Subscription Edition + Specifies the feature definition to be removed. ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: SingleFeatureDefinition -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -112,6 +114,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -123,8 +128,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +138,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -151,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionMetadataConfig.md index 32ce8dfe0..d1fa4259f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionMetadataConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes site subscription configuration settings. - ## SYNTAX ``` @@ -26,20 +25,21 @@ Use the `Remove-SPSiteSubscriptionMetadataConfig` cmdlet to remove the site subs For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------- +### EXAMPLE ```powershell Remove-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" ``` This example removes the site subscription-specific settings from an existing partitioned Metadata Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription for which to remove the Metadata Service application settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the local metadata service proxy for the service application containing the site subscription-specific settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -65,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionProfileConfig.md index f390e66ab..0c15db35a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionProfileConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a site subscription from a User Profile Service application. - ## SYNTAX ### Default @@ -33,10 +32,9 @@ The `Remove-SPSiteSubscriptionProfileConfig` cmdlet deletes a site subscription For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE----------------- +### EXAMPLE ```powershell $sub = Get-SPSiteSubscription https://contoso/my $pr = Get-SPServiceApplicationProxy | ?{$_.DisplayName.Contains(PartitionedUserProfileApplication_Proxy)} @@ -45,10 +43,12 @@ Remove-SPSiteSubscriptionProfileConfig -Identity $sub -ProfileServiceApplication This example removes tenant data. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application that contains the site subscription to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -56,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,13 +66,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Name of the proxy of the User Profile Service application. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for the User Profile service application to connect to. ```yaml Type: SPServiceContextPipeBind Parameter Sets: ServiceContext -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -106,8 +112,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionSettings.md index fb8ddaab3..0c1426db8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteSubscriptionSettings.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the settings service data for a specified site subscription, or finds and removes orphaned data. - ## SYNTAX ### FindAllOrphans @@ -28,7 +27,6 @@ Remove-SPSiteSubscriptionSettings [-Identity] -Si [-AssignmentCollection ] [-Confirm] [-WhatIf] [] ``` - ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. @@ -43,10 +41,9 @@ If this cmdlet is run on a federated service application without specifying the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE 1-------------- +### EXAMPLE 1 ```powershell Remove-SPSiteSubscriptionSettings -FindAllOrphans -Whatif ``` @@ -54,18 +51,19 @@ Remove-SPSiteSubscriptionSettings -FindAllOrphans -Whatif This example finds all orphans and displays them on the screen. Remove the WhatIf parameter to remove these extra settings. - -### ------------EXAMPLE 2-------------- +### EXAMPLE 2 ```powershell Remove-SPSubscriptionSettingsServiceApplication -FindAllOrphans -AlternativeSiteSubscriptions $SubscriptionList ``` Use this example if the service application is consumed by a remote farm and you want the clean orphaned site subscription settings data (an array of all site subscriptions whose data must remain in the service application is assigned to the $SubscriptionList variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription settings service application that contains the service data to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -73,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -84,13 +81,15 @@ Accept wildcard characters: False ``` ### -FindAllOrphans + +> Applicable: SharePoint Server Subscription Edition + Specifies that orphaned settings stores in the service application are deleted. ```yaml Type: SwitchParameter Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -100,6 +99,9 @@ Accept wildcard characters: False ``` ### -SiteSubscriptions + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscriptions with the settings service data to delete. The type must be an array of valid GUIDs. @@ -107,8 +109,7 @@ The type must be an array of valid GUIDs. ```yaml Type: Guid[] Parameter Sets: SpecifySiteSubscriptions -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,6 +119,9 @@ Accept wildcard characters: False ``` ### -AlternativeSiteSubscriptions + +> Applicable: SharePoint Server Subscription Edition + Specifies the complete collection or comma-separated list of site subscriptions that should exist in the settings service application. Any data not matching the items in this list will be removed. @@ -129,8 +133,7 @@ The type must be an array of valid GUIDs. ```yaml Type: Guid[] Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,6 +143,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -151,8 +157,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,6 +167,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -169,7 +177,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -179,13 +186,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Automatically bypasses the secondary warning provided by the cmdlet prior to the operation. ```yaml Type: SwitchParameter Parameter Sets: FindAllOrphans -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -195,6 +204,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -202,7 +214,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteURL.md index 9395dcc10..d54112650 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteURL.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes an URL mapping from the site. - ## SYNTAX ``` @@ -30,27 +29,27 @@ You cannot remove the primary URL for a given site collection, which is typicall For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPSiteURL -Url https://contoso.sharepoint.com ``` This example removes the URL from the site collection, https://contoso.sharepoint.com. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteUpgradeSessionInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteUpgradeSessionInfo.md index 1cadffe28..41b85c389 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteUpgradeSessionInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSiteUpgradeSessionInfo.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes an SPSite object from upgrade. - ## SYNTAX ``` @@ -27,27 +26,27 @@ If the site is not in the upgrade queue, the returned value is Null. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE------------- +### EXAMPLE ```powershell Get-SPSite | Remove-SPSiteUpgradeSessionInfo ``` This example removes the SPSite objects from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site from which to remove the site collections. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSocialItemByDate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSocialItemByDate.md index 01ec2c20a..d12731efd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSocialItemByDate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSocialItemByDate.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes tags, notes, or ratings. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use the `Remove-SPSocialItemByDate` cmdlet to delete, tags, notes, ratings creat For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPSocialItemByDate -RemoveTags 1 -ProfileServiceApplicationProxy c6681d53-e6c4-432f-9f31-22d3de81b00c -EndDate 9/15/2009 ``` This example removes tags before 9/15/09 from the specified User Profile Service Application Proxy. - ## PARAMETERS ### -EndDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the date before which data is to be deleted. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -RemoveComments + +> Applicable: SharePoint Server Subscription Edition + When this parameter is specified, comments will be removed. Valid values for this parameter are: @@ -123,8 +131,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -RemoveRatings + +> Applicable: SharePoint Server Subscription Edition + When this parameter is specified, ratings will be removed. Valid values for this parameter are: @@ -144,8 +154,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -RemoveTags + +> Applicable: SharePoint Server Subscription Edition + When this parameter is specified, tags will be removed. Valid values for this parameter are: @@ -165,8 +177,7 @@ Valid values for this parameter are: ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,14 +187,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -200,7 +216,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolution.md index 46254a105..7a42ef731 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a SharePoint solution from a farm. - ## SYNTAX ``` @@ -26,20 +25,21 @@ Before you use this cmdlet, you must use the `Uninstall-SPSolution` cmdlet to re For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPSolution -Identity contoso_solution.wsp ``` This example removes the SharePoint solution contoso_solution.wsp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint solution to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,14 +100,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the removal of the SharePoint solution. You can use this parameter to remove SharePoint solutions that have been added to the server, even if they have not been deployed by using the `Install-SPSolution` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Removes the language pack for the specified language. The type must be a valid language identifier; for example, 1033. @@ -121,8 +129,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolutionDeploymentLock.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolutionDeploymentLock.md index 27c953a50..511d342de 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolutionDeploymentLock.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPSolutionDeploymentLock.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the solution deployment lock for a server. - ## SYNTAX ``` @@ -26,20 +25,21 @@ If the Identity parameter is not specified, this cmdlet removes the solution dep For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPSolutionDeploymentLock ``` This example removes the solution deployment lock for all servers in the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the server for which the solution deployment lock is to be removed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPStateServiceDatabase.md index 355e9563d..ad3daab64 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPStateServiceDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a state service database from a state service application and drops it from the SQL Server. - ## SYNTAX ``` @@ -26,20 +25,21 @@ To remove a state service database and not delete the database, use the `Dismoun For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Remove-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b ``` This example removes the specified database from a SharePoint Server farm and drops the database from the SQL Server (data loss). - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to remove. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -48,7 +48,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPThrottlingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPThrottlingRule.md index 5c535f992..e28df7de3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPThrottlingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPThrottlingRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a throttling rule. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Remove-SPThrottlingRule` cmdlet to remove a throttling rule from the fa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -39,17 +37,18 @@ Remove-SPThrottlingRule -Identity $throttlingrule This example removes a throttling rule for a specified identity by using the $throttlingrule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the throttling rule object to remove. ```yaml Type: SPThrottlingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTranslationServiceJobHistory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTranslationServiceJobHistory.md index f0cfe088a..c950cb144 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTranslationServiceJobHistory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTranslationServiceJobHistory.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes Machine Translation service jobs. - ## SYNTAX ``` @@ -26,20 +25,21 @@ Use the `Remove-SPTranslationServiceJobHistory` cmdlet to remove a machine trans For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE-------------- +### EXAMPLE ```powershell Remove-SPTranslationServiceJobHistory TranslationService -BeforeDate 2012/01/31 ``` This example removes all jobs completed before 2012/01/31 in the database associated with the Machine Translation Service application named TranslationService. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the instance of the Machine Translation service to remove. The type must be a valid URL, in the form https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -47,8 +47,7 @@ The type must be a valid URL, in the form https://server_name or a valid GUID (f ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -AllPartitions + +> Applicable: SharePoint Server Subscription Edition + Removes all the jobs from the database given other parameters. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -BeforeDate + +> Applicable: SharePoint Server Subscription Edition + Specifies all expired jobs before a given date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -129,14 +136,16 @@ Accept wildcard characters: False ``` ### -IncludeActiveJobs + +> Applicable: SharePoint Server Subscription Edition + Specifies expired jobs which contain active translations. By default, jobs are not deleted if a translation is active. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -JobId + +> Applicable: SharePoint Server Subscription Edition + Specifies only a job Id and its items to expire. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -PartitionId + +> Applicable: SharePoint Server Subscription Edition + Specifies only a partition Id and its items to expire. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -185,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedIdentityTokenIssuer.md index 26146f770..c9da70d01 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedIdentityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a Security Token Service (STS) identity provider from the farm. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPTrustedIdentityTokenIssuer` cmdlet deletes a Security Token servic For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Remove-SPTrustedIdentityTokenIssuer "LiveIDSTS" ``` This example removes an identity provider named LiveIDSTS from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity provider to remove. The type must be one of the following forms: @@ -50,8 +50,7 @@ The type must be one of the following forms: ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +113,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedRootAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedRootAuthority.md index 6f6023944..fa1d98595 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedRootAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes a trusted root authority. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPTrustedRootAuthority` cmdlet deletes a trusted root authority from For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPTrustedRootAuthority -Identity "WFEFarm1" ``` This example removes the trusted root authority WFEFarm1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted root authority to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,14 +56,16 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,13 +75,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -97,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedSecurityTokenIssuer.md index feb4ab743..2b823d3d6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedSecurityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the trusted security token service object. - ## SYNTAX ``` @@ -25,27 +24,27 @@ Use the `Remove-SPTrustedSecurityTokenService` cmdlet to remove the trusted secu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPTrustedSecurityTokenService -Identity FarmA ``` This example removes the trusted security token issuer object named FarmA from the farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ID of the trusted security token issuer object to be removed. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedServiceTokenIssuer.md index d5a8777ce..b641318ff 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPTrustedServiceTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes the object that represents the farm trust. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Remove-SPTrustedServiceTokenIssuer` cmdlet deletes the object that represen For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Remove-SPTrustedServiceTokenIssuer "WFE Farm 2" ``` This example deletes the trusted service token issuer WFE Farm 2. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted service token issuer to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +80,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -102,7 +108,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUsageApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUsageApplication.md index 00e3bc4d0..241cc1d91 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUsageApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUsageApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a usage application from the local farm. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Remove-SPUsageApplication` cmdlet deletes a usage application from the loca For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Remove-SPUsageApplication -Identity "Usage and Health data collection" -RemoveData ``` This example removes the existing usage application and the associated logging DB. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -RemoveData + +> Applicable: SharePoint Server Subscription Edition + Specifies that the logging database is also removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server Subscription Edition + Reserved for future use. ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUser.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUser.md index a6c489608..29160cf23 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUser.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUser.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a user from a Web site. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The `Remove-SPUser` cmdlet does not remove the user from Active Directory Domain For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Remove-SPUser "Contoso\jdoe" -web https://test/web1 Get-SPWeb "https://test/web1" | Remove-SPUser "Contoso\jdoe" @@ -38,18 +36,19 @@ Get-SPWeb "https://test/web1" | Remove-SPUser "Contoso\jdoe" This example removes the user (Contoso\jdoe) from the Web application https://test/web1. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPSite https://contoso.com |Get-SPWeb |Remove-SPUser "Contoso\jdoe" ``` This syntax removes the user (Contoso\Jdoe) from every Web in a site collection located at https://contoso.com. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID, the user name, or SPUser object to remove. The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. @@ -58,7 +57,6 @@ The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -68,6 +66,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the URL or GUID from which the user is to be removed. This parameter is needed only if the identity provided is the user name. @@ -76,8 +77,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +101,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -116,7 +121,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -126,14 +130,16 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server Subscription Edition + The user only gets removed from that group. Otherwise, the user gets removed from the site. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserLicenseMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserLicenseMapping.md index d940f4d8f..13f7c7193 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserLicenseMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserLicenseMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a claim-to-SharePoint user license mapping. - ## SYNTAX ``` @@ -25,28 +24,28 @@ The `Remove-SPUserLicenseMapping` cmdlet uses the Identity parameter to remove a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE--------------- +### EXAMPLE ```powershell Remove-SPUserLicenseMapping -Identity e69ba7cc-4be0-4723-ad63-58d06173afff ``` This example removes the claim-to-license mapping that has the unique ID, e69ba7cc-4be0-4723-ad63-58d06173afff. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique ID of a claim-to-license mapping. The type must be a valid GUID (that is, e69ba7cc-4be0-4723-ad63-58d06173afff). ```yaml Type: System.Collections.Generic.List`1[System.Guid] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSettingsProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSettingsProvider.md index b3cd82fbe..0d1c1c072 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSettingsProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSettingsProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a User Settings Provider. - ## SYNTAX ``` @@ -25,27 +24,27 @@ Use the `Remove-SPUserSettingsProvider` cmdlet to remove a User Settings Provide For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPUserSettingsProvider -Identity "234bf0ed-70db-4158-a332-4dfd683b4148" ``` This example removes a specific User Settings Provider by using the GUID, 234bf0ed-70db-4158-a332-4dfd683b4148. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID ID for a User Settings Provider to remove. ```yaml Type: SPUserSettingsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSolution.md index 111d6d007..491c863d1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPUserSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a sandboxed solution from the solution gallery. - ## SYNTAX ``` @@ -26,20 +25,21 @@ Before you can remove the sandboxed solution from the solution gallery, you must For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE---------------------- +### EXAMPLE ```powershell Remove-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` This example removes the sandboxed solution contoso_solution.wsp from the site https://sitename. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution to remove. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -47,8 +47,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Remove the sandboxed solution from the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -65,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPVisioSafeDataProvider.md index 5541342da..750404c87 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPVisioSafeDataProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a data provider from a Visio Services application. - ## SYNTAX ``` @@ -26,32 +25,31 @@ The `Remove-SPVisioSafeDataProvider` cmdlet deletes the safe data provider that For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ```powershell Remove-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "CustomProvider" -DataProviderType 5 ``` This example removes a safe data provider for a specified Visio Services application. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the data provider to delete. The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. The type must be a valid string that identifies the data provider. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,6 +59,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server Subscription Edition + Specifies the supported type of the data provider to delete. The type must be a valid identity of a data provider type. @@ -68,8 +69,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +79,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -86,8 +89,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPIBinding.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPIBinding.md index 0f2acbf80..581d23bf6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPIBinding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPIBinding.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ### Identity @@ -35,7 +34,7 @@ Remove-SPWOPIBinding [-All] [-AssignmentCollection ] [-C ``` ## DESCRIPTION -The `Remove-SPWOPIBinding` cmdlet removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. +The `Remove-SPWOPIBinding` cmdlet removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. After you run this cmdlet, you can use `New-SPWOPIBinding` to re-create the bindings as needed. If you remove all the bindings for an application, users cannot use Office Web Apps or the SharePoint Share by link feature for that application. If you remove all the bindings on the SharePoint farm where this cmdlet is run, users cannot use Office Web Apps or the SharePoint Share by link feature for any applications in the SharePoint library. @@ -44,43 +43,41 @@ If you want to stop using Office Web Apps for default clicks, but must preserve For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Remove-SPWOPIBinding -Application "Excel" ``` This example removes all bindings for Excel on the current SharePoint farm where this cmdlet is run. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Remove-SPWOPIBinding -All:$true ``` This example removes all bindings on the current SharePoint farm where this cmdlet is run. - -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Get-SPWOPIBinding -Action "MobileView" | Remove-SPWOPIBinding ``` This example removes all bindings for Office Mobile Web Apps on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the binding. ```yaml Type: SPWopiBindingPipeBind Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -90,6 +87,9 @@ Accept wildcard characters: False ``` ### -Action + +> Applicable: SharePoint Server Subscription Edition + Specifies the action to remove bindings for. For example, "view," "edit," and "embedview." For a list of actions run `Get-SPWOPIBinding`. Most typically you will not use this parameter. @@ -98,8 +98,7 @@ If you specify some actions but not others, some features in SharePoint may not ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,13 +108,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server Subscription Edition + Removes all bindings. ```yaml Type: SwitchParameter Parameter Sets: RemoveAll -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,14 +126,16 @@ Accept wildcard characters: False ``` ### -Application + +> Applicable: SharePoint Server Subscription Edition + Specifies application to remove bindings for. Possible applications are as follows: "Word," "Excel," "PowerPoint," or "OneNote." Run `Get-SPWOPIBinding` to get the list of applications. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +145,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -153,8 +159,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,6 +169,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -171,7 +179,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -181,14 +188,16 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extensions to remove bindings for. Run `Get-SPWOPIBinding` to get the list of file name extensions. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,6 +207,9 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server Subscription Edition + Specifies the programmatic identifier (ProgID) for an application to remove bindings for. Run `Get-SPWOPIBinding` to get the list of ProgIDs. You may only want to use this parameter to remove bindings for OneNote. @@ -205,8 +217,7 @@ You may only want to use this parameter to remove bindings for OneNote. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,13 +227,15 @@ Accept wildcard characters: False ``` ### -Server + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of WOPI application (like Office Web Apps Server) to remove bindings for. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -232,6 +245,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -239,7 +255,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -249,13 +264,15 @@ Accept wildcard characters: False ``` ### -WOPIZone + +> Applicable: SharePoint Server Subscription Edition + Specifies the zone to remove bindings for. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPISuppressionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPISuppressionSetting.md index c103957ac..ffaf88e76 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPISuppressionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWOPISuppressionSetting.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes the suppression settings for a file name extension or programmatic ID and action on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ### DocTypeAndAction @@ -32,36 +31,35 @@ The `Remove-SPWOPISuppressionSetting` cmdlet removes the suppression settings fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Remove-SPWOPISuppressionSetting -Extension "XLSX" -Action "view" ``` This example removes suppression settings for viewing Excel workbooks that have the file name extension ".xlsx." - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Get-SPWOPISuppressionSetting | Remove-SPWOPISuppressionSetting ``` This example removes all suppression settings on the current SharePoint farm where this cmdlet is run. - ## PARAMETERS ### -Action -Specifies the action for a given file name extension or programmatic identifier (ProgId). + +> Applicable: SharePoint Server Subscription Edition + +Specifies the action for a given file name extension or programmatic identifier (ProgId). For example, "view," "edit," and "embedview." ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -71,6 +69,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +83,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,6 +93,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -100,7 +103,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -110,14 +112,16 @@ Accept wildcard characters: False ``` ### -Extension + +> Applicable: SharePoint Server Subscription Edition + Specifies the file name extension. Run `Get-SPWOPIBinding` to get the list of file name extensions the WOPI application supports. ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,14 +131,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a string that represents a SPWOPISuppressionSetting. Run `Get-SPWOPISuppressionSetting` to see examples of such strings. ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -144,14 +150,16 @@ Accept wildcard characters: False ``` ### -ProgId + +> Applicable: SharePoint Server Subscription Edition + Specifies the programmatic identifier (ProgID) for an application to suppress. Run `Get-SPWOPIBinding` to get the list of ProgIDs that the WOPI application supports. ```yaml Type: String Parameter Sets: DocTypeAndAction -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,6 +169,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -168,7 +179,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWeb.md index ea29d64a2..460e4501d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWeb.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Completely deletes the specified Web. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The **Remove-SPWeb** cmdlet completely deletes the Web specified by the Identity Deleting the top level Web site of a site collection causes the entire site collection to be removed. - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Remove-SPWeb https://sitename/subsite ``` This example completely deletes a subsite. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web to delete. The type must be a valid full URL, in the form https://server_name/site_name, or an SPWeb object. @@ -46,8 +46,7 @@ The type must be a valid full URL, in the form https://server_name/site_name, or ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,13 +56,16 @@ Accept wildcard characters: False ``` ### -CheckComplianceFlags -Specifies if compliance flags are enabled. + +> Applicable: SharePoint Server Subscription Edition + +Specifies if compliance flags are enabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -72,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -79,8 +84,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -97,7 +104,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,6 +113,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,13 +132,15 @@ Accept wildcard characters: False ``` ### -Recycle + +> Applicable: SharePoint Server Subscription Edition + Specifies if the SPWeb object should be recycled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplication.md index 4eb1b1242..cdf8f9631 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deletes the specified Web application. - ## SYNTAX ### RemoveZoneOfWebApp @@ -37,10 +36,9 @@ If no zone is provided, the entire Web application and all zones are removed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Get-SPWebApplication https://sitename | Remove-SPWebApplication -Zone "Internet" -Confirm ``` @@ -48,18 +46,19 @@ Get-SPWebApplication https://sitename | Remove-SPWebApplication -Zone "Internet" This example prompts and then removes the Internet zone Web application extension on the Web application at https://sitename. This command does not remove the content databases or the IIS Web site. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Remove-SPWebApplication https://sitename -Confirm -DeleteIISSite -RemoveContentDatabases ``` This example permanently removes the Web application, all content databases and the IIS Web site at https://sitename - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or name of the Web application to delete. The type must be a valid URL, in the form https://server_name, or a valid name, in the form WebApplication-1212. @@ -67,8 +66,7 @@ The type must be a valid URL, in the form https://server_name, or a valid name, ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -78,6 +76,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the five zones to be removed. If this parameter is not provided, all Web application zones are removed. @@ -86,8 +87,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: RemoveZoneOfWebApp -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -136,14 +140,16 @@ Accept wildcard characters: False ``` ### -DeleteIISSite + +> Applicable: SharePoint Server Subscription Edition + Deletes the associated IIS Web sites. If this parameter is not provided, the IIS site is not removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,14 +159,16 @@ Accept wildcard characters: False ``` ### -RemoveContentDatabases + +> Applicable: SharePoint Server Subscription Edition + Permanently deletes all associated content databases. If this parameter is not provided, no content databases are removed. ```yaml Type: SwitchParameter Parameter Sets: RemoveWebApp -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,6 +178,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -177,7 +188,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplicationAppDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplicationAppDomain.md index 2c99504e7..d96132029 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplicationAppDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWebApplicationAppDomain.md @@ -26,13 +26,13 @@ This cmdlet also deletes the Internet Information Services (IIS) port binding if ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Remove-SPWebApplicationAppDomain -WebApplication https://www.contoso.com ``` Removes all of the app domains for the specified web application. -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Remove-SPWebApplicationAppDomain -WebApplication https://www.contoso.com -Zone Internet ``` @@ -41,13 +41,15 @@ Removes the app domains for the internet zone for the specified web application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object to remove. ```yaml Type: SPAppDomainPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,16 +59,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -76,14 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -93,15 +97,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWordConversionServiceJobHistory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWordConversionServiceJobHistory.md index 5df276c83..260835b1d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWordConversionServiceJobHistory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Remove-SPWordConversionServiceJobHistory.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes entries from the Word Automation Services job history database. - ## SYNTAX ``` @@ -26,28 +25,28 @@ The `Remove-SPWordConversionServiceJobHistory` cmdlet removes entries from the W For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE 1------------------------ +### EXAMPLE 1 ```powershell Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -BeforeDate 1/1/2009 ``` This example deletes all the items in the database before 1/1/2009. - -### ---------------------EXAMPLE 2------------------------ +### EXAMPLE 2 ```powershell Get-SPServiceApplication -Name TestWordServer | Remove-SPWordConversionServiceJobHistory -JobId 00000000-0000-0112-08FF-63927635FEF1 -IncludeActiveJobs ``` This example deletes the job with the specified ID, even if it is still processing. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Word Automation Services application to be processed. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. @@ -55,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: WordServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,13 +88,15 @@ Accept wildcard characters: False ``` ### -BeforeDate + +> Applicable: SharePoint Server Subscription Edition + Specifies that only jobs started before this date are to be removed. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -111,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -121,14 +125,16 @@ Accept wildcard characters: False ``` ### -IncludeActiveJobs + +> Applicable: SharePoint Server Subscription Edition + Specifies that jobs that contain active conversions can be removed. By default, jobs that have active conversions are not removed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,13 +144,15 @@ Accept wildcard characters: False ``` ### -JobId + +> Applicable: SharePoint Server Subscription Edition + Specifies that only the job with the specified ID is to be removed. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,13 +162,15 @@ Accept wildcard characters: False ``` ### -SubscriptionId + +> Applicable: SharePoint Server Subscription Edition + Specifies that only jobs corresponding to this subscription ID are to be removed. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -177,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPCertificate.md index dab55a023..aae9c0c5b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPCertificate.md @@ -25,7 +25,7 @@ This name will only be visible to SharePoint farm administrators, not to end use ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Rename-SPCertificate -Identity "Team Sites Certificate" -NewFriendlyName "OneDrive Certificate" ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPServer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPServer.md index 07185b780..6ba95cc95 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPServer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Rename-SPServer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Renames a server that is currently connected to the farm. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The server itself must be manually renamed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Rename-SPServer -Identity "wfb1" -Name "WFE1" ``` This example changes the name of the SharePoint server wfb1 to WFE1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the original name of the server. The type must be a URL, in the form https://server_name, or a GUID, in the form 1234-4567-987gb. @@ -48,7 +48,6 @@ The type must be a URL, in the form https://server_name, or a GUID, in the form Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new name of the server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Renew-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Renew-SPCertificate.md index b429cf01a..7ac67ad09 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Renew-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Renew-SPCertificate.md @@ -55,7 +55,7 @@ This tells SharePoint to automatically replace the certificate assignments of th ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Renew-SPCertificate -Identity "Sites Certificate (2020)" -FriendlyName "Sites Certificate (2021)" -Exportable -Path "\\server\fileshare\Team Sites Certificate Signing Request.txt" ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPManagedAccountDeployment.md b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPManagedAccountDeployment.md index 81011ba41..d8d3655a7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPManagedAccountDeployment.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPManagedAccountDeployment.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Repairs the local managed account credential deployment. - ## SYNTAX ``` @@ -27,20 +26,21 @@ The `Repair-SPManagedAccountDeployment` cmdlet should not be used as part of the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Repair-SPManagedAccountDeployment ``` This example repairs the deployment of credentials on all services and Web application associated with managed account (s) on the local server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,6 +62,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -70,7 +72,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPProjectWebInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPProjectWebInstance.md index a5144c270..69590340b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPProjectWebInstance.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/repair-spprojectwebinstance -Applicable: SharePoint Server Subscription Edition + title: Repair-SPProjectWebInstance schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Re-queues specific Project Server queue items that may have fallen out of the queue. - ## SYNTAX ``` @@ -26,27 +25,27 @@ This includes triggers that may have been missed and queue jobs that were enqueu For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Repair-SPProjectWebInstance -Identity https://contoso-appsrv/PWA -RepairRule QueueMissingTriggers ``` This example enqueues any missing triggers for the Project Web App instance at https://contoso-appsrv/PWA. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The identity of the instance of Project Web App. ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,13 +55,15 @@ Accept wildcard characters: False ``` ### -RepairRule + +> Applicable: SharePoint Server Subscription Edition + Valid values: QueueMissingTriggers searches the Project Web App for any triggers that might have been missed; QueueStaleServerGroups re-queues any jobs that were picked up by a server that was subsequently removed from the farm. ```yaml Type: ProjectSiteHealthRuleName Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -72,6 +73,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +87,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPSite.md index 48dc6a4d5..75b2fa0a3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Repair-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Activates the RunRepairs method against the referenced SPSite object. - ## SYNTAX ``` @@ -28,35 +27,34 @@ Run the `Test-SPSite` cmdlet for reports of rules which were run and a summary o For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------EXAMPLE 1--------------- +### EXAMPLE 1 ```powershell Repair-SPSite https:///sites/testsite ``` This example runs all the site collection health checks in repair mode on the https://\/sites/testsite site collection. - -### ------------EXAMPLE 2--------------- +### EXAMPLE 2 ```powershell Repair-SPSite https:///sites/testsite -Rule "ee967197-ccbe-4c00-88e4-e6fab81145e1" ``` This example runs just the "Missing Galleries Check" in repair mode on the https://\/sites/testsite site collection. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site to run a repair. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,13 +107,15 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: SharePoint Server Subscription Edition + Specifies the specific site health rule to run instead of running all applicable rules at once. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,13 +125,15 @@ Accept wildcard characters: False ``` ### -RunAlways + +> Applicable: SharePoint Server Subscription Edition + Forces a rule to run even if a health check was run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Request-SPUpgradeEvaluationSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Request-SPUpgradeEvaluationSite.md index b995149a1..88c263775 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Request-SPUpgradeEvaluationSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Request-SPUpgradeEvaluationSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Requests an upgrade evaluation site for a specified site. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Users can view the site to see how their site will work in the new experience. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $site=Get-SPSite https://contoso.com/sites/TeamSite1 Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email @@ -37,17 +35,18 @@ Request-SPUpgradeEvaluationSite $site -NoUpgrade -Email This example requests an upgrade evaluation site the specified contoso.com team site. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPSite object for the new upgrade evaluation site collection. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,14 +99,16 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server Subscription Edition + Specifies not to send the requester and site collection administrators a notification email when the upgrade evaluation site is ready. The default value is not to send an email message. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -NoUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies not to perform an upgrade as part of the process that creates the upgrade evaluation site. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +146,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectEventServiceSettings.md index b44367cb6..725664ca0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectEventServiceSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/reset-spprojecteventservicesettings -Applicable: SharePoint Server Subscription Edition + title: Reset-SPProjectEventServiceSettings schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. - ## SYNTAX ``` @@ -22,20 +21,21 @@ Reset-SPProjectEventServiceSettings [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,8 +47,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectPCSSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectPCSSettings.md index d6fedefe0..947bae411 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectPCSSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/reset-spprojectpcssettings -Applicable: SharePoint Server Subscription Edition + title: Reset-SPProjectPCSSettings schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Resets the settings for the Project Calculation Engine on Project Server. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The cmdlet requires you to identify the Project Server service application. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Reset-SPProjectPCSSettings -ServiceApplication $sa @@ -37,17 +35,18 @@ Reset-SPProjectPCSSettings -ServiceApplication $sa This cmdlet resets the settings for the Project Calculation Engine that is running on a Project Server Service Application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + The Project Server service application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectQueueSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectQueueSettings.md index 1f7db170e..4d4f62e1c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPProjectQueueSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/reset-spprojectqueuesettings -Applicable: SharePoint Server Subscription Edition + title: Reset-SPProjectQueueSettings schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Resets all Project Server Queue settings to their default values for a specific Project Server Service Application. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Resets all Project Server Queue settings to their default values for a specific For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Reset-SPProjectQueueSettings -ServiceApplication $sa @@ -36,10 +34,12 @@ Reset-SPProjectQueueSettings -ServiceApplication $sa This example resets the queue settings for a Project Server Service Application service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name for a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -48,7 +48,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPSites.md b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPSites.md index f115a6171..55297c658 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPSites.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Reset-SPSites.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/reset-spsites -Applicable: SharePoint Server Subscription Edition + title: Reset-SPSites schema: 2.0.0 --- @@ -26,10 +26,9 @@ It also ensures that all site collections in the content database are registered For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $contentdb = Get-SPContentDatabase ContentDbName Reset-SPSites -Identity $contentDb @@ -37,10 +36,12 @@ Reset-SPSites -Identity $contentDb Synchronizes the sites in the content database named ContentDbName with the configuration database. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,13 +63,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -79,13 +81,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a specific content database. This could either be ID or Name of the content database or a valid instance of a content database. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -102,7 +109,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restart-SPAppInstanceJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restart-SPAppInstanceJob.md index 2f1d52a78..8b8b15376 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restart-SPAppInstanceJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restart-SPAppInstanceJob.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $instance = Get-SPAppInstance -Web https://site_url | ?{$_.Title -eq 'Contoso App'} Restart-SPAppInstanceJob -AppInstance $instance @@ -37,13 +37,15 @@ Restarts the App Instance for the App named 'Contoso App' on https://site_url. ## PARAMETERS ### -AppInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the app instance object to restart. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -64,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -98,7 +107,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPDeletedSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPDeletedSite.md index 1127b7bbf..dc54c1429 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPDeletedSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPDeletedSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Restores a deleted site collection. - ## SYNTAX ``` @@ -33,10 +32,9 @@ For additional information about a server-relative URL or understanding general For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell $deletedSite = Get-SPDeletedSite /sites/site_name Restore-SPDeletedSite -Identity $deletedSite @@ -44,10 +42,12 @@ Restore-SPDeletedSite -Identity $deletedSite This example restores a specific deleted site collection by using the site ID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the deleted site collection to be restored. The identity can be either a valid server-relative URL in the form /sites/site_name; a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPDeletedSite object. @@ -56,8 +56,7 @@ A site collection must not already exist at the URL location to perform a restor ```yaml Type: SPDeletedSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,14 +109,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the Web application from which to list sites. The type must be a valid URL in the form https://server_name; a valid GUID, for example, 12345678-90ab-cdef-1234-567890bcdefgh; or the Web application name, for example, WebApplication1212. @@ -130,8 +138,7 @@ The type must be a valid URL in the form https://server_name; a valid GUID, for ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplication.md index f3a02032a..93c7f3156 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Restores third-party backup of a search application. - ## SYNTAX ### Config @@ -50,10 +49,9 @@ However, Search Application Attach restores configuration, topology and all craw For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell $searchInstance = Get-SPEnterpriseSearchServiceInstance -local $applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" @@ -62,8 +60,7 @@ Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -A This example uses Application Configuration Attach mode to restore configuration data. - -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell $applicationPool = New-SPServiceApplicationPool -Name "SearchServiceApplicationPool" -Account "domain\username" Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool -TopologyFile "C:\TopologyFile.xml" @@ -71,17 +68,18 @@ Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -A This example uses Search Application Attach mode to restore topology data in the file that is named topology.xml. - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new Search application name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -91,13 +89,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the application pool for the query web service. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,13 +107,15 @@ Accept wildcard characters: False ``` ### -AdminSearchServiceInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance to be used with the administration component. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -123,6 +125,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,12 +136,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,15 +149,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -164,6 +168,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the restoring the search application. The type must be a valid name of a SQL Server database, for example, RestoreDB1. @@ -171,8 +178,7 @@ The type must be a valid name of a SQL Server database, for example, RestoreDB1. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -182,13 +188,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the password for the database server on the SQL Server. ```yaml Type: SecureString Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,6 +206,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. @@ -205,8 +216,7 @@ The type must be a valid SQL Server host name, for example, SQLServerHost1. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -216,13 +226,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name that is specified in the Database Server parameter. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -232,13 +244,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Use this parameter if you want the administration database to use a failover database server. ```yaml Type: String Parameter Sets: Config -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -248,13 +262,15 @@ Accept wildcard characters: False ``` ### -KeepId + +> Applicable: SharePoint Server Subscription Edition + Specifies if the search service application ID's from the topology .xml file should be used for the restored search service application. ```yaml Type: SwitchParameter Parameter Sets: Full -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -264,15 +280,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -282,13 +299,15 @@ Accept wildcard characters: False ``` ### -TopologyFile + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the .XML file that contains the application topology information. ```yaml Type: String Parameter Sets: Full -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -298,13 +317,15 @@ Accept wildcard characters: False ``` ### -DeferUpgradeActions + +> Applicable: SharePoint Server Subscription Edition + Prevents database schema update during restore. Do not use. ```yaml Type: SwitchParameter Parameter Sets: Full -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplicationIndex.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplicationIndex.md index 186166744..29a7ec9b6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplicationIndex.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPEnterpriseSearchServiceApplicationIndex.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Restores the search index from the specified backup files. - ## SYNTAX ### Restore @@ -41,10 +40,9 @@ The first set of parameters is for Application Configuration Attach mode and the For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" @@ -53,8 +51,7 @@ Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -Handl This example starts a restore of the search index in the default search service application from a backup located at \\\\sample\backup\spbr0000. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000" Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Service Application" -Handle $handle @@ -62,17 +59,18 @@ Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Ser This example checks the status of the running job to restore of the search index in the search service application Search Service Application with the handle $handle . - ## PARAMETERS ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application that contains the index files that should be restored. ```yaml Type: SearchServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -82,13 +80,15 @@ Accept wildcard characters: False ``` ### -BackupFolder + +> Applicable: SharePoint Server Subscription Edition + Specifies the full file path of the backup files. ```yaml Type: String Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -98,13 +98,15 @@ Accept wildcard characters: False ``` ### -Handle + +> Applicable: SharePoint Server Subscription Edition + A handle returned from an initial call using Parameter set 1. ```yaml Type: String Parameter Sets: RestoreProgress -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -114,13 +116,15 @@ Accept wildcard characters: False ``` ### -AllReplicas + +> Applicable: SharePoint Server Subscription Edition + Specifies a switch to restore all replicas, not just the primary. ```yaml Type: SwitchParameter Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -130,15 +134,16 @@ Accept wildcard characters: False ``` ### -AllowMove -Specifies a switch to move instead of copying files when restoring. -Moving may be faster than copying. +> Applicable: SharePoint Server Subscription Edition + +Specifies a switch to move instead of copying files when restoring. +Moving may be faster than copying. ```yaml Type: SwitchParameter Parameter Sets: Restore -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -148,13 +153,15 @@ Accept wildcard characters: False ``` ### -Retries + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of times to retry if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 5 @@ -164,13 +171,15 @@ Accept wildcard characters: False ``` ### -RetryPauseSeconds + +> Applicable: SharePoint Server Subscription Edition + Seconds to pause between retries if temporary failure occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 6 @@ -180,6 +189,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -191,8 +203,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,6 +213,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -209,7 +223,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -219,6 +232,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -226,7 +242,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPFarm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPFarm.md index c00c13549..753bf1203 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPFarm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPFarm.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Restores one or more items from a backup. - ## SYNTAX ### DefaultSet @@ -38,36 +37,35 @@ This cmdlet can also be used to apply a farm template to the entire farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Restore-SPFarm -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod new -ConfigurationOnly ``` This example restores the configuration settings from the backup package in the \\\\file_server\share\Backup directory to the farm. - -### -------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Restore-SPFarm -ShowTree -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -Item "Microsoft SharePoint Foundation Web Application" -Verbose ``` This example show which components of the farm would be restored under the Microsoft SharePoint Foundation Web Application node, but does not actually restore them. - -### -------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -Force ``` This example restores a farm by using 10 threads and suppresses the overwrite warning. - ## PARAMETERS ### -Directory + +> Applicable: SharePoint Server Subscription Edition + Specifies the path where SharePoint Products stored the backup package. If you have a computer on which SQL Server and an instance of SharePoint Products are installed, you can use local drive paths. This includes a basic installation. @@ -83,8 +81,7 @@ The spbr* folders are created automatically. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +91,9 @@ Accept wildcard characters: False ``` ### -RestoreMethod + +> Applicable: SharePoint Server Subscription Edition + Specifies the method of restore to perform. The valid values are: @@ -104,8 +104,7 @@ The valid values are: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -115,6 +114,9 @@ Accept wildcard characters: False ``` ### -ShowTree + +> Applicable: SharePoint Server Subscription Edition + Displays which objects in the farm will be restored based on the other parameters passed to the `Restore-SPFarm` cmdlet namely the Item and ConfigurationOnly parameters. Items that will be excluded from the restore based on the other parameters passed to the `Restore-SPFarm` cmdlet will be preceded with an asterisk (*). Items that cannot be restored will be enclosed in square brackets (\[ \]). @@ -123,8 +125,7 @@ A restore operation will not be performed if the ShowTree parameter is present. ```yaml Type: SwitchParameter Parameter Sets: ShowTree -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -134,6 +135,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -145,8 +149,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,6 +159,9 @@ Accept wildcard characters: False ``` ### -BackupId + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the backup package that is to be restored. Each backup package has a unique GUID associated with it. The GUID can be seen by using the `Get-SPBackupHistory` cmdlet to view the backup history. @@ -166,8 +172,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,13 +182,15 @@ Accept wildcard characters: False ``` ### -ConfigurationOnly + +> Applicable: SharePoint Server Subscription Edition + Specifies settings only (no data) will be restored from the backup package and applied to objects on the destination farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +200,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -200,7 +210,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -210,6 +219,9 @@ Accept wildcard characters: False ``` ### -FarmCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials that will be used for all components being restored. For example, the application pool credentials for Web applications being restored. If an application pool being restored already exists in the farm, the credentials specified by the FarmCredentials parameter is ignored when restoring that application pool. @@ -217,8 +229,7 @@ If an application pool being restored already exists in the farm, the credential ```yaml Type: PSCredential Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -228,13 +239,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Suppresses the prompt warning that you will overwrite components when you perform an overwrite restore operation. ```yaml Type: SwitchParameter Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -244,6 +257,9 @@ Accept wildcard characters: False ``` ### -Item + +> Applicable: SharePoint Server Subscription Edition + Indicates the part of the backup package to be restored. You can use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if it has a unique name. If multiple items match the name, the full path must be provided. @@ -257,8 +273,7 @@ Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -268,17 +283,19 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies a valid SQL Database Server name. If specified, will be used as a default Database Server name for all databases within the restore operation. -This parameter is only valid when restoring as new. +This parameter is only valid when restoring as new. It is not valid for overwrite restores. ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -288,10 +305,13 @@ Accept wildcard characters: False ``` ### -Percentage + +> Applicable: SharePoint Server Subscription Edition + Requests that progress updates about the restore operation be displayed in increments of that percentage. For example, a value of 5 displays restore progress updates at every 5 percent completed, and a value of 10 displays restore progress updates at every 10 percent completed. -Note: Progress will only be displayed in the output if the -Verbose parameter is specified. +Note: Progress will only be displayed in the output if the -Verbose parameter is specified. Otherwise, you may see the progress in the restore log file. This percentage is not precise and the actual progress updates might be lower or higher than requested. @@ -305,8 +325,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -316,9 +335,12 @@ Accept wildcard characters: False ``` ### -RestoreThreads + +> Applicable: SharePoint Server Subscription Edition + The number of threads that should be used during the restore. -The fewer the restore threads, the easier it is to understand the restore log. +The fewer the restore threads, the easier it is to understand the restore log. However, the more restore threads, the more components can be restored in parallel, potentially resulting in a faster restore. The valid range is between 1 and 10. @@ -327,8 +349,7 @@ The default value is 3. ```yaml Type: Int32 Parameter Sets: DefaultSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -338,6 +359,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -345,7 +369,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPSite.md index 9699bc9d0..353c82e70 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Restore-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Restores a site collection. - ## SYNTAX ### DatabaseFromPipebind @@ -38,36 +37,35 @@ The `Restore-SPSite` cmdlet performs a restoration of the site collection to a l A content database may only contain one copy of a site collection. If a site collection is backed up and restored to a different URL location within the same Web application, an additional content database must be available to hold the restored copy of the site collection. - ## EXAMPLES -### ----------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Restore-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak ``` This example restores a site collection from the backup file C:\Backup\site_name.bak to the site collection URL https://server_name/sites/site_name. - -### ----------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Restore-SPSite https://server_name/sites/site_name -Path C:\Backup\site_name.bak -Force -DatabaseServer SQLBE1 -DatabaseName SQLDB1 ``` This example restores a site collection backup from the backup file C:\Backup\site_name.bak, but overwrites the existing site collection at https://server_name/sites/site_name while specifying that the site collection must be stored in a specific content database. - -### ----------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ```powershell Restore-SPSite https://www.example.com -Path \\file_server\share\site_name.bak -HostHeaderWebApplication https://server_name ``` This example restores a site collection backup from the backup file \\\\file_server\share\site_name.bak to the host-named site collection https://www.example.com on the Web application https://server_name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL location to which the site collection is restored. A site collection does not have to already exist at the URL location to perform a restore. @@ -79,8 +77,7 @@ The type must be a valid URL, in the form https://server_name/sites/site_name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -90,14 +87,16 @@ Accept wildcard characters: False ``` ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies a valid path to the location of the backup. For example, C:\Backup\site_name.bak. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -107,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -118,8 +120,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,14 +149,16 @@ Accept wildcard characters: False ``` ### -ContentDatabase -Specifies the SQL Server content database where the site collection data will be stored. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: DatabaseFromPipebind -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +168,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. @@ -171,8 +179,7 @@ The type must be a valid database name, in the form SQLDB1. ```yaml Type: String Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,6 +189,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the SQL Server containing the content database specified by the DatabaseName parameter. The type must be a valid database server name, in the form SQLBE1 and needs to be used in conjunction with the DatabaseName parameter. @@ -189,8 +199,7 @@ The type must be a valid database server name, in the form SQLBE1 and needs to b ```yaml Type: String Parameter Sets: DatabaseParameter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,13 +209,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specifies that the existing site collection at the URL location is to be overwritten by this restoration. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,14 +227,16 @@ Accept wildcard characters: False ``` ### -GradualDelete + +> Applicable: SharePoint Server Subscription Edition + Specifies that the site collection being overwritten with the Force parameter should be gradually deleted over time by a timer job instead of all at once, which reduces its impact on SharePoint Products and SQL Server performance. This option is recommended for large site collections. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -233,6 +246,9 @@ Accept wildcard characters: False ``` ### -HostHeaderWebApplication + +> Applicable: SharePoint Server Subscription Edition + A valid URL assigned to the Web application by using alternate access mapping, such as https://server_name Restores a site collection as a host-named site collection instead of a path-based site collection. @@ -241,8 +257,7 @@ When the HostHeaderWebApplication parameter is present, the value of the Identit ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -252,6 +267,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -259,7 +277,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -269,13 +286,15 @@ Accept wildcard characters: False ``` ### -PreserveSiteID + +> Applicable: SharePoint Server Subscription Edition + Preserves the original Site ID instead of creating a new one. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPEnterpriseSearchServiceApplication.md index 563656a92..ee09b8573 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPEnterpriseSearchServiceApplication.md @@ -24,10 +24,9 @@ This cmdlet reads the SearchServiceApplication object and moves it from the Paus For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA $ssa | Resume-SPEnterpriseSearchServiceApplication @@ -38,6 +37,9 @@ This example obtains a reference to a search service application named MySSA and ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to resume. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, MyQueryServer); or an instance of a valid SearchServiceApplication object. @@ -45,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPProjectWebInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPProjectWebInstance.md index c8d895e5e..6c3df8c58 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPProjectWebInstance.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/resume-spprojectwebinstance -Applicable: SharePoint Server Subscription Edition + title: Resume-SPProjectWebInstance schema: 2.0.0 --- @@ -26,10 +26,9 @@ The database must be set to read-write before you run this cmdlet, or this cmdle For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} $instance = Get-SPProjectWebInstance -ServiceApplication $sa @@ -41,14 +40,16 @@ Resumes the Project Web Server Instance in the Project Web Application Service A ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the instance of Project Web App to be switched to read-write mode. It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite). ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPStateServiceDatabase.md index cb8121229..4251f5707 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Resume-SPStateServiceDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Resumes a paused state service database so that new rows of data are received. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Resume-SPStateServiceDatabase` cmdlet resumes a paused state service databa For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE------------------ +### EXAMPLE ```powershell $db = Get-SPStateServiceDatabase -Identity StateServceDbName Resume-SPStateServiceDatabase -Identity $db @@ -36,10 +34,12 @@ Resume-SPStateServiceDatabase -Identity $db This example resumes a paused state service database. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to resume. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -48,7 +48,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPBusinessDataCatalogMetadataObject.md index 579acdfb6..401c81635 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPBusinessDataCatalogMetadataObject.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Revokes a right to a principal in the specified Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Revoke-SPBusinessDataCatalogMetadataObject` cmdlet revokes a right granted For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $claimJohn = New-SPClaimsPrincipal -Identity "CONTOSO\johndoe" -IdentityType WindowsSamAccountName $MetadataObject = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase" @@ -38,17 +36,18 @@ Revoke-SPBusinessDataCatalogMetadataObject -Identity $MetadataObject -Principal This example removes the execute right from the External System with the name ContosoDatabase for the user with the identity of johndoe on the domain CONTOSO. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object that contains the principal. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the principal to whom the rights apply. The type must be a claim. @@ -65,8 +67,7 @@ The type must be a claim. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server Subscription Edition + Specifies the right to revoke the principal. The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients. @@ -83,8 +87,7 @@ The type must be one of the following valid PSBdcRight object types: All, Execut ```yaml Type: PSBdcRight Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom environment settings model slice for which to revoke the right. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -140,8 +150,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -158,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPObjectSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPObjectSecurity.md index 3b51bd4ad..f5964f391 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPObjectSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Revoke-SPObjectSecurity.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/revoke-spobjectsecurity -Applicable: SharePoint Server Subscription Edition + title: Revoke-SPObjectSecurity schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes a security principal from a SPObjectSecurity object. - ## SYNTAX ### RevokeOne @@ -37,10 +36,9 @@ An SPObjectSecurity object is a common object that is used to represent the secu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $security = Get-SPServiceApplicationSecurity $serviceApp -Admin Revoke-SPObjectSecurity $security "domain\user" @@ -50,18 +48,19 @@ Set-SPServiceApplicationSecurity $serviceApp -Admin $security This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and removes a user from that ACL. The removed an administrator for the service application $serviceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPObjectSecurity object from which the security principal is removed. You can use the `Get-SPServiceApplicationSecurity` cmdlet to get a SPObjectSecurity object . ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the principal for whom the rights are removed. The type must a valid name a principal; for example, Full Control. @@ -78,8 +80,7 @@ The type must a valid name a principal; for example, Full Control. ```yaml Type: SPClaim Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -Rights + +> Applicable: SharePoint Server Subscription Edition + Specifies the rights of the principal to revoke. The type must a valid array of strings that represents the rights of the principal to revoke. @@ -96,8 +100,7 @@ The type must a valid array of strings that represents the rights of the princip ```yaml Type: String[] Parameter Sets: RevokeOne -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -107,13 +110,15 @@ Accept wildcard characters: False ``` ### -All + +> Applicable: SharePoint Server Subscription Edition + Specifies that all security principals are removed from the specified SPObjectSecurity object. ```yaml Type: SwitchParameter Parameter Sets: RevokeAll -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,8 +142,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAlternateURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAlternateURL.md index ebd4f523c..2e7937b52 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAlternateURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAlternateURL.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the specified alternate URL. - ## SYNTAX ``` @@ -26,44 +25,42 @@ This cmdlet can be used to change only the zone of internal URLs and cannot be u For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Set-SPAlternateURL -Identity https://www.contoso.com -Zone "Internet" ``` This example changes the zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Set-SPAlternateURL -Identity https://www.contoso.com -Url https://sharepoint.contoso.com -Zone "Default" ``` This example changes the URL and zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Get-SPAlternateURL https://www.contoso.com | Set-SPAlternateURL -Zone "Internet" ``` This example changes the zone of the alternate URL https://www.contoso.com. - -### ------------------EXAMPLE 4------------------ +### EXAMPLE 4 ```powershell Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Set-SPAlternateURL -Zone "Intranet" ``` This example changes the zone of the alternate URL for the specified Web application from Extranet to Intranet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the alternate URL to change. The type must be a valid URL, in the form https://server_name/WebApplication/site, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -71,8 +68,7 @@ The type must be a valid URL, in the form https://server_name/WebApplication/sit ```yaml Type: SPAlternateUrlPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -82,13 +78,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the new alternate URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +96,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Sets the supplied alternate URL as one of the five zones. The type must be any one of the following values: Default, Intranet, Internet, Extranet, or Custom. @@ -105,8 +106,7 @@ The type must be any one of the following values: Default, Intranet, Internet, E ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +116,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +130,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +140,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -155,6 +159,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -162,7 +169,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAcquisitionConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAcquisitionConfiguration.md index 05a5caca7..9ee21e617 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAcquisitionConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAcquisitionConfiguration.md @@ -33,35 +33,34 @@ Use the Set-SPAppAcquisitionConfiguration cmdlet to set app acquisition settings For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPAppAcquisitionConfiguration -WebApplication https://localhost -Enable:$false ``` This example disabled app purchases for the specified Web Application. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPAppAcquisitionConfiguration -SiteSubscription https://localhost/sites/SharePointOnlineAdmin1 -Enable:$false ``` This example disables app purchases for the specified tenant. - ## PARAMETERS ### -Enable -Specifies whether acquisition is enabled or disabled. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether acquisition is enabled or disabled. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,14 +70,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription -Specifies the site collection for which to set app acquisition settings. +> Applicable: SharePoint Server Subscription Edition + +Specifies the site collection for which to set app acquisition settings. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: MarketplaceSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,16 +88,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,14 +108,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,14 +126,15 @@ Accept wildcard characters: False ``` ### -WebApplication -Specifies the web application for which acquisitions settings are to be set. +> Applicable: SharePoint Server Subscription Edition + +Specifies the web application for which acquisitions settings are to be set. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: MarketplaceSettingsInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -141,15 +144,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAutoProvisionConnection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAutoProvisionConnection.md index f39c32dc5..4302b305e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAutoProvisionConnection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppAutoProvisionConnection.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets provision connection settings for an app. - ## SYNTAX ### WebHostEndPoint @@ -51,18 +50,16 @@ Use the `Set-SPAppAutoProvisionConnection` cmdlet to set provision connection se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SpAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username ``` This example configures remote web host to be used provision apps that use this functionality for the default site subscription server on https://SPremotewebhost. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell $subscription = Get-SPSiteSubscription https://Contoso.com Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username -SiteSubscription $subscription @@ -70,33 +67,32 @@ Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https:/ This example configures remote web host to be used provision apps that use this functionality for the site subscription of Contoso.com site to server on https://SPremotewebhost. - -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost ``` This example updates the endpoint of the already configured remote web host server https://SPRemotewebhost for the default site subscription. - -### --------------------EXAMPLE 4--------------------- +### EXAMPLE 4 ```powershell Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -Remove ``` This example removes the remote web host configuration for the default site subscription. - ## PARAMETERS ### -ConnectionType + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection type to provision. ```yaml Type: ConnectionTypes Parameter Sets: WebHostEndPoint, WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,13 +102,15 @@ Accept wildcard characters: False ``` ### -EndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the end point of the provision connection. ```yaml Type: String Parameter Sets: WebHostEndPoint, WebHostSetup -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -122,13 +120,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the provision connection. ```yaml Type: String Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,13 +138,15 @@ Accept wildcard characters: False ``` ### -Remove + +> Applicable: SharePoint Server Subscription Edition + Removes the auto provision connection of the app. ```yaml Type: SwitchParameter Parameter Sets: Remove -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -154,13 +156,15 @@ Accept wildcard characters: False ``` ### -Username + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name of the connection. ```yaml Type: String Parameter Sets: WebHostSetup, WebHostCredential -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -170,6 +174,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -181,8 +188,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -192,13 +198,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for which the provision connection is to be associated. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDisablingConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDisablingConfiguration.md index 5e8f8652d..2802b8b07 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDisablingConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDisablingConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the disable list sync state for an app. - ## SYNTAX ``` @@ -25,28 +24,27 @@ Use the Set-SPAppDisablingConfiguration cmdlet to set the disabled sync list sta For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPAppDisablingConfiguration ``` This example sets the disable sync state for apps. - ## PARAMETERS ### -Enable -Specifies whether to enable or disable an entry from the list. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether to enable or disable an entry from the list. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,16 +54,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,14 +74,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -92,15 +92,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDomain.md index 3180b0f2b..d6f942e60 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppDomain.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the domain used to host apps. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Set-SPAppDomain` cmdlet to set the domain used to host apps in the farm For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPAppDomain -Domain apps.contoso.com ``` @@ -36,17 +34,18 @@ Set-SPAppDomain -Domain apps.contoso.com This example sets the app domain to apps.contoso.com. All apps in the farm will be hosted in the apps.contoso.com domain. - ## PARAMETERS ### -AppDomain + +> Applicable: SharePoint Server Subscription Edition + Specifies the domain to be used for apps. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppHostingQuotaConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppHostingQuotaConfiguration.md index 145af809c..1bf545779 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppHostingQuotaConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppHostingQuotaConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets hosting quotas for an app. - ## SYNTAX ``` @@ -26,36 +25,34 @@ Use the Set-SPAppHostingQuotaConfiguration cmdlet to set hosting quotas for a sp For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### ----------------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell Set-SPAppHostingQuotaConfiguration -Identity 586d4a32-98c3-42ce-80be-3c76c10c250c -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 ``` This example sets hosting Quotas for the SiteSubscriptionId "586d4a32-98c3-42ce-80be-3c76c10c250c" with hosted appinstance limit as 50 and hosted apps licenses assigned as 25. - -### ----------------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell Get-SPSiteSubscription | Set-SPAppHostingQuotaConfiguration -Identity $_ -AppInstanceCountQuota 50 -AppHostingLicenseQuota 25 ``` This example sets hosting Quotas for all SiteSubscriptions in the farm with hosted apps limit as 50 and hosted apps licenses assigned as 25. - ## PARAMETERS ### -AppHostingLicenseQuota -Specifies the app licensing quota. +> Applicable: SharePoint Server Subscription Edition + +Specifies the app licensing quota. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -65,13 +62,15 @@ Accept wildcard characters: False ``` ### -AppInstanceCountQuota + +> Applicable: SharePoint Server Subscription Edition + Specifies the number instances of an app. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,16 +80,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,14 +100,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -117,15 +118,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -135,13 +137,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the Site Subscription. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppManagementDeploymentId.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppManagementDeploymentId.md index 808819547..f16e04787 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppManagementDeploymentId.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppManagementDeploymentId.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the identifier of the farm or tenant used by the Office Marketplace to issue App licenses. - ## SYNTAX ``` @@ -27,10 +26,9 @@ To ensure you do not lose rights to the use of all Apps you have purchased on th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell $sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa @@ -38,8 +36,7 @@ Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24B This example sets the deployment identifier of the current farm to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell $sa = Get-SPServiceApplication | where {$_.TypeName -eq "App Management Service Application"} Get-SPSiteSubscription | where{$_.Id -eq "88f16a50-0530-4f3f-b749-24ef0b30d685"} | Set-SPAppManagementDeploymentId -DeploymentId 3102B7C3-1866-48EE-91CB-84E20AD24BF2 -AppManagementServiceApplication $sa @@ -47,17 +44,18 @@ Get-SPSiteSubscription | where{$_.Id -eq "88f16a50-0530-4f3f-b749-24ef0b30d685"} This example sets the deployment identifier of the tenant with the site subscription identifier 88f16a50-0530-4f3f-b749-24ef0b30d685 to 3102B7C3-1866-48EE-91CB-84E20AD24BF2. - ## PARAMETERS ### -AppManagementServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the app management service application object that is running on the farm. ```yaml Type: AppManagementServiceApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,6 +65,9 @@ Accept wildcard characters: False ``` ### -DeploymentId + +> Applicable: SharePoint Server Subscription Edition + Specifies the deployment identifier value for the tenant. This parameter works in conjunction with the value that is defined with Identity parameter. If Identity parameter is omitted, then it is assumed that this deployment identifier value belongs to the farm. @@ -74,8 +75,7 @@ If Identity parameter is omitted, then it is assumed that this deployment identi ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -85,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +119,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Identifies the site subscription object representing the tenant to which the DeploymentId parameter is to be assigned. If the Identity parameter is omitted, it is assumed that the deployment identifier belongs to the farm. @@ -131,7 +138,6 @@ If the Identity parameter is omitted, it is assumed that the deployment identifi Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) Aliases: Subscription -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,6 +147,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppPrincipalPermission.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppPrincipalPermission.md index 0b87ea4ff..6b5f9d934 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppPrincipalPermission.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppPrincipalPermission.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the permissions on a given app principal. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Use the `Set-SPAppPrincipalPermission` cmdlet to set the permissions on a given For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE------------- +### EXAMPLE ```powershell $clientID = "11111111-2222-3333-4444-555555555555" $site = Get-SPSite https://siteUrl @@ -45,13 +43,15 @@ This example sets the App Principal permission to Manage with a scope of Site. ## PARAMETERS ### -AppPrincipal + +> Applicable: SharePoint Server Subscription Edition + Specifies the AppPrincipal object. ```yaml Type: SPAppPrincipal Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,6 +61,9 @@ Accept wildcard characters: False ``` ### -Right + +> Applicable: SharePoint Server Subscription Edition + Specifies the permission level for the principal object. The value is any of the following levels: @@ -76,8 +79,7 @@ The value is any of the following levels: ```yaml Type: SPCmdletAppPrincipalPermissionKind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope to which to apply the principal permission. The value is any of the following scopes: @@ -100,8 +105,7 @@ The value is any of the following scopes: ```yaml Type: SPCmdletAppPrincipalPermissionScope Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -111,13 +115,15 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site (that is, SPWeb object) that the AppPrincipalPermission is being set.a ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -127,6 +133,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +147,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +157,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -156,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -166,6 +176,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +186,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -183,6 +195,9 @@ Accept wildcard characters: False ``` ### -EnableAppOnlyPolicy + +> Applicable: SharePoint Server Subscription Edition + Specifies if the app only policy is turned on for the app principal. The valid values are True and False. The default value is False. @@ -190,8 +205,7 @@ The valid values are True and False. The default value is False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppScaleProfile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppScaleProfile.md index fe84d0809..76360fa25 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppScaleProfile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppScaleProfile.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets settings for the app profile. - ## SYNTAX ``` @@ -25,20 +24,21 @@ Use the `Set-SPAppScaleProfile` cmdlet to set settings for an app profile. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE----------- +### EXAMPLE ```powershell Set-SPAppScaleProfile -MaxDatabaseSize "2 GB" -RemoteWebSiteInstanceCount 1 ``` This example sets the farm level app scale profile. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +50,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -MaxDatabaseSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the database size of the app profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,13 +78,15 @@ Accept wildcard characters: False ``` ### -RemoteWebSiteInstanceCount + +> Applicable: SharePoint Server Subscription Edition + Specifies whether a remote site can access the profilefrom. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteDomain.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteDomain.md index 70775d636..85d57f51d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteDomain.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteDomain.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates or changes the URL of any installed app. - ## SYNTAX ``` @@ -23,28 +22,27 @@ Set-SPAppSiteDomain -Site [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + +Specifies the SPSite object or the GUID of the SPSite or the URL of the SPSite. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -54,16 +52,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,14 +72,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,15 +90,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteSubscriptionName.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteSubscriptionName.md index e4e004061..bf7936196 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteSubscriptionName.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppSiteSubscriptionName.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets or changes the name for the specified site subscription. - ## SYNTAX ``` @@ -25,28 +24,28 @@ Use the `Set-SPAppSiteSubscriptionName` cmdlet to set or change the name for a s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell Set-SPAppSiteSubscriptionName -Name Contoso ``` This example sets the name of the default site subscription to "Contoso". - -### -----------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell Set-SPAppSiteSubscriptionName -Name Contoso -SiteSubscription https://www.contoso.com ``` This example changes the name of the site subscription for SPSite from https://www.contoso.com to "Contoso". - ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name for the site subscription. Each site subscription must have a unique name. @@ -55,8 +54,7 @@ The name is used in part to determine the domain that apps for SharePoint are in ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,14 +107,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + The site subscription name is recorded in other databases in the SharePoint farm. In cases such as disaster recovery or restore of the SharePoint farm, the Force parameter can be specified to ensure that the site subscription name has been propagated appropriately throughout the SharePoint farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +126,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPSiteSubscription object or the SPSiteSubscription Id or the URL of an SPSite. If this parameter is not specified, then the default site subscription is used. All SharePoint SPSites are members of the default site subscription if they have not been specifically assigned a site subscription. @@ -129,8 +136,7 @@ All SharePoint SPSites are members of the default site subscription if they have ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,6 +146,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -147,7 +156,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStateUpdateInterval.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStateUpdateInterval.md index e0f6672b3..de83ee387 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStateUpdateInterval.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the interval in hours between updates of the app state update job. - ## SYNTAX ``` @@ -26,28 +25,28 @@ The app state update job updates the app states, including app updates, in Share For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ```powershell Set-SPAppStateUpdateInterval -AppStateSyncHours 24 -FastAppRevocationHours 6 ``` This example sets the app state update interval to 24 hours and the fast app revocation interval to 6 hours. - ## PARAMETERS ### -AppStateSyncHours + +> Applicable: SharePoint Server Subscription Edition + Specifies the interval in hours between updates of the app states. Values are 1 to 24 inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,14 +56,16 @@ Accept wildcard characters: False ``` ### -FastAppRevocationHours + +> Applicable: SharePoint Server Subscription Edition + Specifies the interval in hours between checks of the list of revoked apps in the SharePoint Store. If the list of revoked apps has changed from the last time, the app states are updated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreConfiguration.md index 515e0b056..cb95105ef 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets SharePoint Store settings for an app. - ## SYNTAX ``` @@ -25,25 +24,23 @@ Use the Set-SPAppStoreConfiguration cmdlet to set SharePoint Store settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPAppStoreConfiguration -Url https://office.microsoft.com -Enable $true ``` This example sets the URL to the Office.com server. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPAppStoreConfiguration -Enable $false ``` This example turns off the SharePoint Store. -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Set-SPAppStoreConfiguration -Enable $true ``` @@ -53,16 +50,17 @@ This example turns on the SharePoint Store. ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the app for which to set SharePoint Store settings. The SharePoint store value should not be changed unless instructed by a Microsoft representative. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -72,16 +70,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,14 +90,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -108,15 +108,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -126,6 +127,9 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the Office Store services lets third- party add-ins to be found or downloaded. This is intended for administrators to disable discovery and downloads of third-party add-ins on their SharePoint tenants and site collections. @@ -137,8 +141,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreWebServiceConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreWebServiceConfiguration.md index a41a3008e..732c464c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreWebServiceConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAppStoreWebServiceConfiguration.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spappstorewebserviceconfiguration -Applicable: SharePoint Server Subscription Edition + title: Set-SPAppStoreWebServiceConfiguration schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a SharePoint Store app. - ## SYNTAX ``` @@ -27,10 +26,9 @@ This cmdlet is not intended for the ITPro audience. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPAppStoreWebServiceConfiguration -Client=SP -ProxyVersion=16.1 ``` @@ -40,6 +38,9 @@ This example set the product type and version for a SharePoint Store app. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -47,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -58,13 +58,15 @@ Accept wildcard characters: False ``` ### -Client + +> Applicable: SharePoint Server Subscription Edition + Specifies the client value of the SharePoint Store app. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ``` ### -ProxyVersion + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy version value of the SharePoint Store app. ```yaml Type: Version Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -106,6 +112,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -113,7 +122,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPApplicationCredentialKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPApplicationCredentialKey.md index 3acbf2599..7c9825072 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPApplicationCredentialKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPApplicationCredentialKey.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spapplicationcredentialkey -Applicable: SharePoint Server Subscription Edition + title: Set-SPApplicationCredentialKey schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the application credential key on the local server. - ## SYNTAX ``` @@ -20,7 +19,6 @@ Set-SPApplicationCredentialKey [-Password] [-AssignmentCollection [-WhatIf] [-Confirm] [] ``` - ## DESCRIPTION Use the **Set-SPApplicationCredentialKey** cmdlet to set the application credential key on the local server, which is used by certain features to encrypt and decrypt passwords. @@ -28,7 +26,7 @@ The application credential key must be identical on each server in the farm wher ## EXAMPLES -### ------------EXAMPLE ----------- +### EXAMPLE ```powershell $key = ConvertTo-SecureString -String "New Password" -AsPlainText -Force Set-SPApplicationCredentialKey -Password $key @@ -39,6 +37,9 @@ This example sets the application credential key on the local server to "New Pas ## PARAMETERS ### -Password + +> Applicable: SharePoint Server Subscription Edition + Specifies the application credential key. Avoid reusing the farm passphrase or service account passwords for the application credential key. @@ -46,7 +47,7 @@ Avoid reusing the farm passphrase or service account passwords for the applicati Type: SecureString Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: True Position: 1 Default value: None @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,7 +71,7 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -76,13 +80,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -91,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -98,7 +108,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -110,6 +120,5 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Remove-SPApplicationCredentialKey](Remove-SPApplicationCredentialKey.md) diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAuthenticationRealm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAuthenticationRealm.md index 0bdd7732f..8ef089bc8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAuthenticationRealm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPAuthenticationRealm.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the authentication realm. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Set-SPAuthenticationRealm` cmdlet to set the authentication realm at th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $c = Get-SPServiceContext -Site "https://" Set-SPAuthenticationRealm -ServiceContext $c -Realm "t686d436-9f16-42db-09b7-cb578e110ccd" @@ -36,10 +34,12 @@ Set-SPAuthenticationRealm -ServiceContext $c -Realm "t686d436-9f16-42db-09b7-cb5 This example sets the authentication realm as specified by the realm parameter. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -51,8 +51,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -69,7 +71,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -79,13 +80,15 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server Subscription Edition + Specifies the realm to be set. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,14 +98,16 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + Specifies the service context for which the realm needs to be set. For example, $root.web. ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsBlock.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsBlock.md index 3ab4bca71..6f1d0fc9d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsBlock.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsBlock.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets Bing maps to blocked status. - ## SYNTAX ``` @@ -28,27 +27,27 @@ Use a value of 1 to block in all locales. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPBingMapsBlock 1 ``` This example displays how to block Bing Maps in all locales for the farm. - ## PARAMETERS ### -BlockBingMapsInAllLocales + +> Applicable: SharePoint Server Subscription Edition + Specifies whether Bing Maps are blocked in all locales. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsKey.md index 7f5c7e3f9..5f17b8c73 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBingMapsKey.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the Bing Maps key. - ## SYNTAX ``` @@ -27,27 +26,27 @@ For additional information about Bing Keys, see Bing Maps Account Center (https: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPBingMapsKey -BingKey ``` This example sets the key that is used by Bing Maps. - ## PARAMETERS ### -BingKey + +> Applicable: SharePoint Server Subscription Edition + Specifies the Bing Maps key to set. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBrowserCustomerExperienceImprovementProgram.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBrowserCustomerExperienceImprovementProgram.md index 12aaa27dd..d1cda1f5c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBrowserCustomerExperienceImprovementProgram.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBrowserCustomerExperienceImprovementProgram.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Turns on or off the browser Customer Experience Improvement Program. - ## SYNTAX ### Farm @@ -42,43 +41,41 @@ The `Set-SPBrowserCustomerExperienceImprovementProgram` cmdlet turns on or off t For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable ``` This example turns on the browser Customer Experience Improvement Program for the farm. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable:$False ``` This example turns off the browser Customer Experience Improvement Program for the farm. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell Set-SPWebApplication https://MyOfficeApp1 | Get- SPBrowserCustomerExperienceImprovementProgram -Enable ``` This example turns on the browser Customer Experience Improvement Program for the Web application, MyOfficeApp1. - ## PARAMETERS ### -Farm + +> Applicable: SharePoint Server Subscription Edition + {{Fill Farm Description}} ```yaml Type: SwitchParameter Parameter Sets: Farm -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +85,9 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Sets the Customer Experience Improvement Program opt-in state for the specified site subscription. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. @@ -95,8 +95,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,6 +105,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Sets the Customer Experience Improvement Program opt-in state for the specified SharePoint Web application. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -113,8 +115,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -124,6 +125,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -135,8 +139,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +149,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,14 +168,16 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Turns on the browser Customer Experience Improvement Program. The default value is True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +187,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -187,7 +197,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogEntityNotificationWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogEntityNotificationWeb.md index 37c88f4ec..3133f9b44 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogEntityNotificationWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogEntityNotificationWeb.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the entity notification site. - ## SYNTAX ``` @@ -25,27 +24,27 @@ Use the `Set-SPBusinessDataCatalogEntityNotificationWeb` cmdlet to sets the enti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPBusinessDataCatalogEntityNotificationWeb -Web "https://contoso" ``` This example sets https://contoso as the entity notification site for the service context of the site at https://contoso. - ## PARAMETERS ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the site to be set as the entity notification site for its own service context. ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,6 +54,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +68,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +88,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +107,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogMetadataObject.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogMetadataObject.md index c3b85ad66..c7ea8df42 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogMetadataObject.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogMetadataObject.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object. - ## SYNTAX ### Display @@ -45,10 +44,9 @@ The `Set-SPBusinessDataCatalogMetadataObject` cmdlet sets the value of a propert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $obj = Get-SPBusinessDataCatalogMetadataObject -Namespace "ContosoDatabase" -Name "ContosoDatabase" -BdcObjectType "LobSystemInstance" -ServiceContext http://contoso Set-SPBusinessDataCatalogMetadataObject -Identity $obj -PropertyName "ShowInSearchUI" -PropertyValue "True" @@ -57,17 +55,18 @@ Set-SPBusinessDataCatalogMetadataObject -Identity $obj -PropertyName "ShowInSear This example creates a property on the LobSystemInstance (External System Instance) of name ContosoDatabase. The property has the name ShowInSearchUI and a value of True. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity Metadata Store metadata object to update. ```yaml Type: MetadataObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,13 +119,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the Business Data Connectivity Metadata Store metadata object. ```yaml Type: String Parameter Sets: Display -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -PropertyName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the property to update. ```yaml Type: String Parameter Sets: NameValue, NameRemove -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,13 +155,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server Subscription Edition + Sets the new value of the property specified in the PropertyName parameter. ```yaml Type: PSObject Parameter Sets: NameValue -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -Remove + +> Applicable: SharePoint Server Subscription Edition + Removes the property specified in the PropertyName parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -SettingId + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom environment settings model slice for which the property applies. The type must be a valid string that identifies a model slice; for example, ModelSlice1. @@ -187,8 +201,7 @@ The type must be a valid string that identifies a model slice; for example, Mode ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -205,7 +221,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogServiceApplication.md index b392a8bc7..a48576504 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets global properties for a Business Data Connectivity service application in the farm. - ## SYNTAX ``` @@ -28,10 +27,9 @@ The `Set-SPBusinessDataCatalogServiceApplication` cmdlet sets global properties For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Business Data Connectivity Service Application'} Set-SPBusinessDataCatalogServiceApplication -Identity $sa -FailoverDatabaseServer "CONTOSO\Backup" @@ -39,17 +37,18 @@ Set-SPBusinessDataCatalogServiceApplication -Identity $sa -FailoverDatabaseServe This example sets the failover database server to CONTOSO\Backup for the given service application. - ## PARAMETERS ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS application pool to use for the new Business Data Connectivity service application. ```yaml Type: SPIisWebServiceApplicationPool Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -66,8 +68,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Business Data Connectivity database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -84,8 +88,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -103,8 +109,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Business Data Connectivity database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -121,8 +129,7 @@ The type must be a valid name of a SQL Server database; for example, UsageLogDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the catalog database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database. @@ -140,8 +150,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -158,8 +170,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,13 +180,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Business Data Connectivity service application associated with the new proxy. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a display name for the new Business Data Connectivity service application proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Business Data Connectivity service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -217,6 +234,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -224,7 +244,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -234,6 +253,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -241,7 +263,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -251,13 +272,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + {{Fill AssignmentCollection Description}} ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogThrottleConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogThrottleConfig.md index 9347247e0..d6c260f60 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogThrottleConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPBusinessDataCatalogThrottleConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the throttling configuration for a Business Data Connectivity Service application. - ## SYNTAX ### MaxDefault @@ -36,27 +35,27 @@ The `Set-SPBusinessDataCatalogThrottleConfig` cmdlet sets the throttling configu For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy | Set-SPBusinessDataCatalogThrottleConfig -Maximum 1000000000 -Default 500000 ``` This example sets the database item throttling to values of 1000000000 maximum and 500000 default for the given service application. - ## PARAMETERS ### -Default + +> Applicable: SharePoint Server Subscription Edition + Specifies the default setting of the throttle configuration. ```yaml Type: Int32 Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,13 +65,15 @@ Accept wildcard characters: False ``` ### -Enforced + +> Applicable: SharePoint Server Subscription Edition + Specifies that the throttle configuration setting cannot be overridden. ```yaml Type: SwitchParameter Parameter Sets: Enforcement -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the throttle configuration to update. ```yaml Type: ThrottleConfig Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -98,13 +101,15 @@ Accept wildcard characters: False ``` ### -Maximum + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum value of the throttling configuration setting. ```yaml Type: Int32 Parameter Sets: MaxDefault -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -125,8 +133,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -160,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCentralAdministration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCentralAdministration.md index b170cce53..ddc748aba 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCentralAdministration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCentralAdministration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the IIS website binding for the SharePoint Central Administration site. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Set-SPCentralAdministration` cmdlet sets the IIS website binding for the Sh For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831](https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPCentralAdministration -Port 8282 ``` This example sets the port for the Central Administration web application on the local farm to 8282. - ## PARAMETERS ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -52,7 +52,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +85,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the certificate that will be used for the Secure Sockets Layer (SSL) binding of this IIS website. This parameter is only valid when used with the SecureSocketsLayer parameter. @@ -91,7 +95,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SPServerCertificatePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + The host header of the Central Administration IIS website. If this parameter is omitted, there will be no host header binding and the URL of the Central Administration site will be based on the name of this server. @@ -109,7 +115,6 @@ If this parameter is omitted, there will be no host header binding and the URL o Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: SharePoint Server Subscription Edition + Specifies the administration port for the Central Administration site. The type must be a valid port number; for example, 8080. @@ -126,8 +134,7 @@ The type must be a valid port number; for example, 8080. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Enables Secure Sockets Layer (SSL) encryption for the Central Administration IIS website. If you choose to use SSL, you must import a server certificate to SharePoint and assign it to the Central Administration IIS website for this web application. The Central Administration web application won't be accessible until you do this. @@ -148,8 +158,7 @@ If this parameter is omitted or set to False, the Central Administration site wi ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the load-balanced URL for Central Administration. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -175,6 +186,9 @@ Accept wildcard characters: False ``` ### -UseServerNameIndication + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Sockets Layer (SSL) binding of this IIS website should use Server Name Indication (SNI). Server Name Indication allows multiple IIS websites with unique host headers and unique server certificates to share the same SSL port. If Server Name Indication isn't used, all IIS websites sharing the same SSL port must share the same server certificate. @@ -183,7 +197,6 @@ If Server Name Indication isn't used, all IIS websites sharing the same SSL port Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -193,6 +206,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -200,7 +216,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -210,6 +225,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -217,7 +235,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCertificateSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCertificateSettings.md index def35d758..fe7639a7b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCertificateSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCertificateSettings.md @@ -29,7 +29,7 @@ These include default properties for creating and renewing certificates and cert ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Set-SPCertificateSettings -CertificateExpirationWarningThreshold 22 ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPClaimProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPClaimProvider.md index 3cf345c6b..c583ef9e1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPClaimProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPClaimProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates registration of a claims provider. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Set-SPClaimProvider` cmdlet updates registration of a claims provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh" ``` This example turns off the specified claim provider. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the claim provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object. @@ -46,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +80,15 @@ Accept wildcard characters: False ``` ### -Default + +> Applicable: SharePoint Server Subscription Edition + Specifies that the claim provider applies to all Web applications and zones. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,13 +98,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: SharePoint Server Subscription Edition + Turns on the claim provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDatabase.md index 661251e79..355830f1a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets global properties of a SharePoint content database. - ## SYNTAX ``` @@ -26,28 +25,28 @@ The `Set-SPContentDatabase` cmdlet sets global properties of a SharePoint conten For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE 1--------------- +### EXAMPLE 1 ```powershell Get-SPContentDatabase https://contoso.com | Set-SPContentDatabase -MaxSiteCount 1 ``` This example sets the MaxSiteCount for the content database that contains contoso.com to 1. - -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ```powershell Get-SPContentDatabase -WebApplication https://sitename | Set-SPContentDatabase -WarningSiteCount $null ``` This example clears the WarningSiteCount for all databases in the sitename Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object. @@ -55,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -95,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,6 +107,9 @@ Accept wildcard characters: False ``` ### -MaxSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of site collections that this database can host. The type must be a positive integer. @@ -113,8 +118,7 @@ Set to $null to clear this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: SharePoint Server Subscription Edition + Specifies the status of the SQL Server database. Set this parameter to Online to make the database available to host new sites. Set this parameter to Disabled to make the database unavailable to host new sites. @@ -133,8 +140,7 @@ The type must be either of the following: Online or Disabled ```yaml Type: SPObjectStatus Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -144,6 +150,9 @@ Accept wildcard characters: False ``` ### -WarningSiteCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of site collections that can be created before a warning event is generated and the owner of the site collection is notified. The type must be a positive integer. @@ -152,8 +161,7 @@ Set to $null to clear this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +171,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -170,7 +181,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -180,13 +190,15 @@ Accept wildcard characters: False ``` ### -DatabaseFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the mirror server for failover. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentJob.md index 35dc9ff25..ee7cc76b8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentJob.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a content deployment job. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPContentDeploymentJob` cmdlet sets the properties of a content deploym For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPContentDeploymentJob "Job 1" | Set-SPContentDeploymentJob -Schedule "hourly between 0 and 59" -ScheduleEnabled:$true ``` This example sets the deployment job called Job 1 to run hourly. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment job to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description for the content deployment job. The name can be a maximum of 4096 alphanumeric characters. @@ -108,8 +114,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -EmailAddresses + +> Applicable: SharePoint Server Subscription Edition + Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object. The type must be a list of valid e-mail addresses. @@ -126,8 +134,7 @@ The type must be a list of valid e-mail addresses. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -EmailNotifications + +> Applicable: SharePoint Server Subscription Edition + Specifies how e-mail notifications are sent about this ContentDeploymentJob object. The type must be one of the following: @@ -150,8 +160,7 @@ The type must be one of the following: ```yaml Type: ContentDeploymentNotificationSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,6 +170,9 @@ Accept wildcard characters: False ``` ### -HostingSupportEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables special hosting behavior. The default value is False. @@ -171,8 +183,7 @@ Therefore, when the HostingSupportEnabled parameter is set to True, the hoster c ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,13 +193,15 @@ Accept wildcard characters: False ``` ### -IncrementalEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that only incremental changes are deployed to the destination site collection. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the new content deployment job. The type must be a valid name of a content deployment job; for example, DeployJob1. @@ -205,8 +221,7 @@ The type must be a valid name of a content deployment job; for example, DeployJo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,6 +231,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server Subscription Edition + Sets the schedule for the deployment job. The type must be a valid SPSchedule object. @@ -223,8 +241,7 @@ The type must be a valid SPSchedule object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -234,14 +251,16 @@ Accept wildcard characters: False ``` ### -ScheduleEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables the schedule for the deployment job. If the schedule is not enabled, the job can be run manually only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -251,6 +270,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Sets the scope of the deployment job. SPSite objects that are passed in must exist in the current path of the source site collection. The default scope is the entire site collection. @@ -261,8 +283,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -272,6 +293,9 @@ Accept wildcard characters: False ``` ### -SqlSnapshotSetting + +> Applicable: SharePoint Server Subscription Edition + Backs up the SharePoint Foundation content database by using SQL Server. The type must be one of the following values: None or CreateNew. @@ -279,8 +303,7 @@ The type must be one of the following values: None or CreateNew. ```yaml Type: ContentDeploymentSqlSnapshotSetting Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -290,6 +313,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -297,7 +323,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentPath.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentPath.md index 1c939f821..b5feec342 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentPath.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPContentDeploymentPath.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a content deployment path. - ## SYNTAX ``` @@ -29,20 +28,21 @@ The `Set-SPContentDeploymentPath` cmdlet sets the properties of a content deploy For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Get-SPContentDeploymentPath "Path 1" | Set-SPContentDeploymentPath -PathEnabled:$false ``` This example sets the deployment path Path 1 to be disabled. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment path to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentPathPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Authentication + +> Applicable: SharePoint Server Subscription Edition + Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application. The type must be one of the following values: WindowsAuth or BasicAuth. @@ -90,8 +94,7 @@ The type must be one of the following values: WindowsAuth or BasicAuth. ```yaml Type: PathAuthenticationOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,13 +104,15 @@ Accept wildcard characters: False ``` ### -CompressionEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on compression during the export. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -DeploySecurityInformation + +> Applicable: SharePoint Server Subscription Edition + Specifies the user and group information to include during the export operation for this content deployment path. The default value is All. @@ -128,8 +136,7 @@ No user information defined in the DAP or LDAP servers is included. ```yaml Type: SPIncludeSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,13 +146,15 @@ Accept wildcard characters: False ``` ### -DeployUserNamesEnabled + +> Applicable: SharePoint Server Subscription Edition + Specify to enable event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Sets the description for the content deployment path. The description can contain a maximum of 4096 alphanumeric characters. @@ -163,8 +175,7 @@ The type must be a valid string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -174,6 +185,9 @@ Accept wildcard characters: False ``` ### -DestinationCentralAdministrationURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Central Administration URL for the destination farm. The type must be a valid URL, in the form http://server_name. @@ -181,8 +195,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -192,13 +205,15 @@ Accept wildcard characters: False ``` ### -EventReceiversEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on event receivers during import. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -208,6 +223,9 @@ Accept wildcard characters: False ``` ### -KeepTemporaryFilesOptions + +> Applicable: SharePoint Server Subscription Edition + Specifies that temporary files are kept after content deployment is finished. The type must be one of the following values: Never, Always, or OnFailure. @@ -215,8 +233,7 @@ The type must be one of the following values: Never, Always, or OnFailure. ```yaml Type: TemporaryFilesOption Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -226,6 +243,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the content deployment path. The type must be a valid name of a content deployment path; for example, DeploymentPath1. @@ -233,8 +253,7 @@ The type must be a valid name of a content deployment path; for example, Deploym ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -244,6 +263,9 @@ Accept wildcard characters: False ``` ### -PathAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies the user ID that is an administrator on the Central Administration page on the destination farm. The type must be a valid SharePoint user. @@ -251,8 +273,7 @@ The type must be a valid SharePoint user. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -262,13 +283,15 @@ Accept wildcard characters: False ``` ### -PathEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables the content deployment path. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -278,6 +301,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -285,7 +311,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -295,13 +320,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCustomLayoutsPage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCustomLayoutsPage.md index 57c468ff2..af5ae0e4d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCustomLayoutsPage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPCustomLayoutsPage.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Maps a new path for a custom layout page. - ## SYNTAX ### CustomPage @@ -39,20 +38,21 @@ To remove the mapping for a custom layouts page, use the Reset parameter instead For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPCustomLayoutsPage -Identity AccessDenied -RelativePath "/_layouts/custompages/myaccessdenied.aspx" -WebApplication "https://server_name/mywebapp" ``` This example maps the specified path for the AccessDenied layout page in the Web application "https://server_name/mywebapp". - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the custom layout page to set. The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted. @@ -60,8 +60,7 @@ The type must be one of the following: None, AccessDenied, Confirmation, Error, ```yaml Type: SPCustomPage Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -RelativePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the custom layout page. The type must be a valid path of a layout page, in the form _layouts/custompages/myaccessdenied.aspx. @@ -78,8 +80,7 @@ The type must be a valid path of a layout page, in the form _layouts/custompages ```yaml Type: String Parameter Sets: CustomPage -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -89,13 +90,15 @@ Accept wildcard characters: False ``` ### -Reset + +> Applicable: SharePoint Server Subscription Edition + Resets the mapping of a custom layouts page. ```yaml Type: SwitchParameter Parameter Sets: ResetCustomPage -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web application that contains the custom layout page. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -112,8 +118,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -123,6 +128,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -134,8 +142,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -152,7 +162,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -169,7 +181,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -179,13 +190,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDataConnectionFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDataConnectionFile.md index f9672d7dd..3fb483565 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDataConnectionFile.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a data connection file. - ## SYNTAX ``` @@ -26,44 +25,42 @@ The `Set-SPDataConnectionFile` cmdlet sets the properties of the data connection For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Set-SPDataConnectionFile -Identity "sample.udcx" -Category "Temp" ``` This example updates the Category of the specified .udcx file. - -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Set-SPDataConnectionFile -Identity "sample.udcx" -DisplayName "NewDisplayName" ``` This example updates the DisplayName of the specified .udcx file. - -### --------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Sample.udcx" | Set-SPDataConnectionFile -Category "Temp" ``` This example updates the Category of the specified .udcx file. - -### --------------EXAMPLE 4----------------- +### EXAMPLE 4 ```powershell Get-SPDataConnectionFile | where {$_.Category -eq "Category1"} | Set-SPDataConnectionFile -Category "Category2" ``` This example updates the Category field for the collection of .udcx files that are returned from a query used by the `Get-SPDataConnectionFile` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the data connection file to update. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -71,8 +68,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -82,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +102,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Sets an arbitrary category on the file which can be used to group the files. The category name can have a maximum of 255 characters. @@ -112,8 +113,7 @@ The type must be a valid string value; for example, Category1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -140,6 +142,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Sets the description for the data connection file. The name can be a maximum of 4096 alphanumeric characters. @@ -148,8 +153,7 @@ The type must be a valid string; for example, Description of my universal data c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,6 +163,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name that describes the data connection file. The name can have a maximum of 255 characters. @@ -167,8 +174,7 @@ The type must be a valid string; for example, InfoPathUDC1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,6 +184,9 @@ Accept wildcard characters: False ``` ### -WebAccessible + +> Applicable: SharePoint Server Subscription Edition + Specifies that the universal data connection file can be accessed by using the Web service. If false, only the forms server can retrieve the universal data connection files internally. The default value is False. @@ -185,8 +194,7 @@ The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -196,6 +204,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -203,7 +214,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDefaultProfileConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDefaultProfileConfig.md index 4b3582e44..717f8ac7e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDefaultProfileConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDefaultProfileConfig.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spdefaultprofileconfig -Applicable: SharePoint Server Subscription Edition + title: Set-SPDefaultProfileConfig schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes the MySitesPublicEnabled property of the User Profile Application Proxy. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the Set-SPDefaultProfileConfig cmdlet to change the MySitesPublicEnabled pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715)](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPDefaultProfileConfig $proxy -MySitesPublicEnabled $true @@ -37,10 +35,12 @@ Set-SPDefaultProfileConfig $proxy -MySitesPublicEnabled $true This example changes the MySitesPublicEnabled property of the specified user profile service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -48,8 +48,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -MySitesPublicEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables or disables public MySites. The valid values are $True or $False. @@ -82,8 +86,7 @@ The valid values are $True or $False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application that contains the site subscription to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -109,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -116,7 +124,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDesignerSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDesignerSettings.md index cae534508..c66f86fc8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDesignerSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDesignerSettings.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets SharePoint Designer features. - ## SYNTAX ``` @@ -29,27 +28,27 @@ The `Set-SPDesignerSettings` cmdlet sets SharePoint Designer features on a speci For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Set-SPDesignerSettings -WebApplication https://contoso -AllowRevertFromTemplate $False -AllowMasterPageEditing $False ``` This example disables the ability to detach pages from existing site definitions and to edit master pages and page layouts. - ## PARAMETERS ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application in which the settings will apply. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,14 +58,16 @@ Accept wildcard characters: False ``` ### -AllowDesigner + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to allow users to edit sites in a web application by using SharePoint Designer. The default value is True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -76,14 +77,16 @@ Accept wildcard characters: False ``` ### -AllowMasterPageEditing + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to allow site administrators to customize master pages and layout pages using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,14 +96,16 @@ Accept wildcard characters: False ``` ### -AllowRevertFromTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to allow site administrators to detach pages from the original site definition using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -121,8 +129,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +149,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -149,14 +158,16 @@ Accept wildcard characters: False ``` ### -ShowURLStructure + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to allow site administrators to manage the URL structure of their Web sites by using SharePoint Designer. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -AllowCreateDeclarativeWorkflow + +> Applicable: SharePoint Server Subscription Edition + Allows the creation of declarative workflows. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,13 +214,15 @@ Accept wildcard characters: False ``` ### -AllowSaveDeclarativeWorkflowAsTemplate + +> Applicable: SharePoint Server Subscription Edition + Allows saving declarative workflows as a template. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -215,13 +232,15 @@ Accept wildcard characters: False ``` ### -AllowSavePublishDeclarativeWorkflow + +> Applicable: SharePoint Server Subscription Edition + Allows saving of published declarative workflows. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -231,6 +250,9 @@ Accept wildcard characters: False ``` ### -DesignerDownloadUrl + +> Applicable: SharePoint Server Subscription Edition + Sets the URL to the SharePoint Designer download. The default value is: https://go.microsoft.com/fwlink/?LinkId=328584 @@ -238,8 +260,7 @@ https://go.microsoft.com/fwlink/?LinkId=328584 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -249,15 +270,17 @@ Accept wildcard characters: False ``` ### -RequiredDesignerVersion -Sets the required version of SharePoint Designer. The default value is + +> Applicable: SharePoint Server Subscription Edition + +Sets the required version of SharePoint Designer. The default value is 15.0.0.0 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticConfig.md index cfc7cf6df..07c3c6041 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets diagnostic configuration settings on the farm. - ## SYNTAX ``` @@ -32,18 +31,16 @@ Use the `Set-SPDiagnosticConfig` cmdlet to set diagnostic configuration settings For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Set-SPDiagnosticConfig -ErrorReportingEnabled -DownloadErrorReportingUpdatesEnabled:$false -DaysToKeepLog 60 ``` This example enables ErrorReporting, disables DownloadErrorReportingUpdatesEnable and sets DaysToKeepLog to 60. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell $config = Get-SPDiagnosticConfig $config.CustomerExperienceImprovementProgramEnabled = $false @@ -53,17 +50,18 @@ $config | Set-SPDiagnosticConfig This example disables CEIP and sets LogCutInterval to 60 minutes. - ## PARAMETERS ### -AllowLegacyTraceProviders + +> Applicable: SharePoint Server Subscription Edition + Specifies that trace providers built for previous versions of SharePoint Products and Technologies can write to the trace session for SharePoint Products. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -73,13 +71,15 @@ Accept wildcard characters: False ``` ### -AppAnalyticsAutomaticUploadEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether aggregated app usage data is automatically uploaded to Microsoft. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -100,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +113,9 @@ Accept wildcard characters: False ``` ### -CustomerExperienceImprovementProgramEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether participation in the Customer Experience Improvement Program (CEIP) is enabled. The CEIP is designed to improve the quality, reliability, and performance of Microsoft products and technologies. @@ -126,8 +131,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,15 +141,17 @@ Accept wildcard characters: False ``` ### -DaysToKeepLogs -Specifies the number of days to keep trace log files. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the number of days to keep trace log files. The type must be a valid number between 1 and 366. The default value is 14 days. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +161,9 @@ Accept wildcard characters: False ``` ### -DownloadErrorReportingUpdatesEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the error reporting remote control file is downloaded. The type must be either of the following values: @@ -167,8 +176,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,6 +186,9 @@ Accept wildcard characters: False ``` ### -ErrorReportingAutomaticUploadEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether error reports are uploaded to Microsoft automatically. Error reports include the following: information regarding the condition of the server when a problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. @@ -193,8 +204,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,6 +214,9 @@ Accept wildcard characters: False ``` ### -ErrorReportingEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether collection of error reports is enabled. Error reports are created when your system encounters hardware or software problems. @@ -221,8 +234,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -232,6 +244,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the Event log flood protection feature is enabled. If multiple similar events are written to the event log, some duplicate messages are suppressed. @@ -247,8 +262,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -258,6 +272,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionNotifyInterval + +> Applicable: SharePoint Server Subscription Edition + Specifies in minutes how often to write a summary event indicating how many events were suppressed due to flood protection. The integer range is between 1 and 1440. @@ -266,8 +283,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -277,6 +293,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionQuietPeriod + +> Applicable: SharePoint Server Subscription Edition + Specifies in minutes how much time must pass without an event firing to exit flood protection. The integer range is between 1 and 1440. @@ -285,8 +304,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -296,6 +314,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of events allowed in a given timeframe before an event is considered to be flooding the event log. The integer range is between 1 and 100. @@ -304,8 +325,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -315,6 +335,9 @@ Accept wildcard characters: False ``` ### -EventLogFloodProtectionTriggerPeriod + +> Applicable: SharePoint Server Subscription Edition + Specifies in minutes the timeframe to watch for events that may be flooding. The integer range is between 1 and 1440. @@ -323,8 +346,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -334,13 +356,15 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server Subscription Edition + Use the result from the `Get-SPDiagnosticConfig` cmdlet, make modifications and then pipeline the object into `Set-SPDiagnosticConfig` cmdlet to update the content database. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -350,6 +374,9 @@ Accept wildcard characters: False ``` ### -LogCutInterval + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of minutes between log file rollovers. The value must be a valid integer between 0 and 1440. @@ -359,8 +386,7 @@ The default value is 30. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -370,6 +396,9 @@ Accept wildcard characters: False ``` ### -LogDiskSpaceUsageGB + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum amount of storage to use for trace log files, in gigabytes (GB). The default value is 1000 and only takes effect when the LogMaxDiskSpaceusageEnabled cmdlet is set to True. @@ -379,8 +408,7 @@ The type must be a valid number between 1 and 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -390,6 +418,9 @@ Accept wildcard characters: False ``` ### -LogLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of where to log files will reside. The type must be a valid path, in the form C:\Logs. @@ -399,8 +430,7 @@ The default location is %CommonProgramFiles%\Microsoft Shared\Web Server Extensi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -410,6 +440,9 @@ Accept wildcard characters: False ``` ### -LogMaxDiskSpaceUsageEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to restrict the maximum space to use for trace log files. The type must be either of the following values: @@ -422,8 +455,7 @@ The default value is $False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -433,6 +465,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingDelay + +> Applicable: SharePoint Server Subscription Edition + Specifies the time (in minutes) between script error reports. The type must be a valid integer between 0 and 1440. @@ -443,8 +478,7 @@ The default value is 30. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -454,6 +488,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether error reporting is enabled for client script errors. The type must be either of the following values: @@ -466,8 +503,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -477,6 +513,9 @@ Accept wildcard characters: False ``` ### -ScriptErrorReportingRequireAuth + +> Applicable: SharePoint Server Subscription Edition + Specifies whether script error reporting requires authentication. The type must be either of the following values: @@ -489,8 +528,7 @@ The default value is $True. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticsProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticsProvider.md index cdcb688b7..60bec3627 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticsProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDiagnosticsProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Enables a diagnostics provider and updates its retention policy. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Set-SPDiagnosticsProvider` cmdlet enables a diagnostics provider and update For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable:$false Get-SPDiagnosticsProvider job-diagnostics-event-log-provider @@ -37,8 +35,7 @@ Get-SPDiagnosticsProvider job-diagnostics-event-log-provider This example disables the event log diagnostics provider. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable -DaysRetained 10 Get-SPDiagnosticsProvider job-diagnostics-event-log-provider @@ -46,10 +43,12 @@ Get-SPDiagnosticsProvider job-diagnostics-event-log-provider This example enables the event log diagnostics provider and changes its retention policy to 10 days. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the diagnostics provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticProv1); or an instance of a valid SPDiagnosticsProvider object. @@ -57,8 +56,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPDiagnosticsProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -68,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -79,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -97,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,6 +109,9 @@ Accept wildcard characters: False ``` ### -DaysRetained + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days to retain the data collected by a diagnostics provider. The type must be a valid integer value in the range of 1 to 14. @@ -114,8 +119,7 @@ The type must be a valid integer value in the range of 1 to 14. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,13 +129,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Turns on or off the specified diagnostics provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +147,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -158,13 +166,15 @@ Accept wildcard characters: False ``` ### -MaxTotalSizeInBytes + +> Applicable: SharePoint Server Subscription Edition + The maximum size of the partition within the Usage database. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDistributedCacheClientSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDistributedCacheClientSetting.md index 5b86b8cfc..0a9e53fa5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDistributedCacheClientSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPDistributedCacheClientSetting.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets distributed cache settings. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Usage can be any type of cache that the ContainerType parameter specifies. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $settings = Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache $settings.MaxConnectionsToServer = 10 @@ -39,10 +37,12 @@ Set-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -D This example updates the MaxConnectionsToServer to 10 for DistributedLogonTokenCache. - ## PARAMETERS ### -ContainerType + +> Applicable: SharePoint Server Subscription Edition + Specifies the container type to clear. The valid values are the following: @@ -67,12 +67,10 @@ The valid values are the following: -DistributedViewStateCache - ```yaml Type: SPDistributedCacheContainerType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -82,14 +80,16 @@ Accept wildcard characters: False ``` ### -DistributedCacheClientSettings + +> Applicable: SharePoint Server Subscription Edition + Updates the various cache client settings. It is recommended to use the default settings. ```yaml Type: SPDistributedCacheClientSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -99,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchAdministrationComponent.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchAdministrationComponent.md index 0980304b6..b9498e3c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchAdministrationComponent.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchAdministrationComponent.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of an administration component for a search service application. - ## SYNTAX ``` @@ -28,22 +27,23 @@ The Set-SPEnterpriseSearchAdministrationComponent cmdlet updates properties of a For permissions and the most current information about search cmdlets, see the online documentation, [https://go.microsoft.com/fwlink/?LinkId=163185](https://go.microsoft.com/fwlink/?LinkId=163185). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell - $ssa = Get-SPEnterpriseSearchServiceApplication "Search Service Application" + $ssa = Get-SPEnterpriseSearchServiceApplication "Search Service Application" $admin = Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa $admin | Set-SPEnterpriseSearchAdministrationComponent -SearchServiceInstance SP02 -Force ``` This example moves the administration component to a different server. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -51,8 +51,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -62,13 +61,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,13 +79,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specifies that the admin component must be moved to the new search service instance. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the administration component to update. The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid AdminComponent object. @@ -101,8 +107,7 @@ The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcde ```yaml Type: AdminComponentPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 0 @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the administration component. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -119,8 +127,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -SearchServiceInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance to host the administration component. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -137,8 +147,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -StoragePath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path for storing data for the administration component. The path must contain a valid file share and use valid registry characters. The type must be a valid path in either of the following forms: @@ -159,8 +171,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,6 +181,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -177,7 +191,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md index 0706db786..729634dae 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchContentEnrichmentConfiguration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Stores the specified content enrichment configuration to the search service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Both a ContentEnrichmentConfiguration and a SearchServiceApplication object have For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1 ------------------ +### EXAMPLE 1 ```powershell $config = New-SPEnterpriseSearchContentEnrichmentConfiguration $config.Endpoint = "https://server/service" @@ -43,12 +41,11 @@ Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -Co This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed properties. +The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. +It is also configured to expect the external web service to output the same managed properties. The SearchServiceApplication object is retrieved and used for storing the newly created ContentEnrichmentConfiguration. - -### ------------------EXAMPLE 2 ------------------ +### EXAMPLE 2 ```powershell $config = New-SPEnterpriseSearchContentEnrichmentConfiguration $config.Endpoint = "https://server/service" @@ -61,22 +58,23 @@ Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -Co This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. -The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. -It is also configured to expect the external web service to output the same managed property. +The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. +It is also configured to expect the external web service to output the same managed property. The $config.Trigger is set to only send the managed property when the Boolean trigger expression is true, in this case when the managed property Title contains the string "Example". The SearchServiceApplication object is retrieved, and used for storing the newly created ContentEnrichmentConfiguration. - ## PARAMETERS ### -ContentEnrichmentConfiguration + +> Applicable: SharePoint Server Subscription Edition + Specifies the ContentEnrichmentConfiguration that should be stored in the SearchServiceApplication. ```yaml Type: ContentEnrichmentConfigurationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,13 +84,15 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -113,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +155,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlContentSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlContentSource.md index 6a826494f..7ece9615e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlContentSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlContentSource.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a crawl content source for a Search service application. - ## SYNTAX ### MonthlyDate @@ -84,10 +83,9 @@ Search service application administrators can still configure full crawls as nee For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $cs = Get-SPEnterpriseSearchCrawlContentSource -Identity 'Local SharePoint Sites' -SearchApplication $ssa @@ -97,10 +95,12 @@ $cs | Set-SPEnterpriseSearchCrawlContentSource -ScheduleType Incremental -DailyC This example returns the "Local SharePoint Sites" content source and creates a schedule to run a full crawl every 30 days and an incremental crawl every hour every day. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,12 +109,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,15 +122,16 @@ Accept wildcard characters: False ``` ### -BDCApplicationProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy to use for a business type content source. This proxy group must contain a default Business Data Connectivity Metadata Store proxy. - ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,15 +141,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -160,17 +160,18 @@ Accept wildcard characters: False ``` ### -CrawlPriority + +> Applicable: SharePoint Server Subscription Edition + Specifies the priority of this content source. The type must be one of the following integers: 1= Normal, 2=High. - ```yaml Type: CrawlPriority Parameter Sets: (All) Aliases: p Accepted values: Normal, High -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -180,14 +181,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleDaysOfMonth -Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set. +> Applicable: SharePoint Server Subscription Edition + +Specifies the days on which to crawl when the MonthlyCrawlSchedule parameter is set. ```yaml Type: Int32 Parameter Sets: MonthlyDate -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,15 +199,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleDaysOfWeek -Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set. +> Applicable: SharePoint Server Subscription Edition + +Specifies the days on which to crawl when the WeeklyCrawlSchedule parameter is set. ```yaml Type: DaysOfWeek Parameter Sets: Weekly -Aliases: +Aliases: Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Weekdays, Saturday, Weekends, Everyday -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -215,15 +218,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleMonthsOfYear -Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set. +> Applicable: SharePoint Server Subscription Edition + +Specifies the months on which to crawl when the MonthlyCrawlSchedule parameter is set. ```yaml Type: MonthsOfYear Parameter Sets: MonthlyDate Aliases: month Accepted values: January, February, March, April, May, June, July, August, September, October, November, December, AllMonths -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -233,14 +237,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRepeatDuration -Specifies the number of times to repeat the crawl schedule. +> Applicable: SharePoint Server Subscription Edition + +Specifies the number of times to repeat the crawl schedule. ```yaml Type: Int32 Parameter Sets: MonthlyDate, Weekly, Daily Aliases: duration -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -250,14 +255,15 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRepeatInterval -Specifies the number of minutes between each repeat interval for the crawl schedule +> Applicable: SharePoint Server Subscription Edition + +Specifies the number of minutes between each repeat interval for the crawl schedule ```yaml Type: Int32 Parameter Sets: MonthlyDate, Weekly, Daily Aliases: interval -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -267,18 +273,19 @@ Accept wildcard characters: False ``` ### -CrawlScheduleRunEveryInterval + +> Applicable: SharePoint Server Subscription Edition + Specifies the interval between crawls. When the DailyCrawlSchedule parameter is set, specifies the number of days between crawls. When the WeeklyCrawlSchedule parameter is set, specifies the number of weeks between crawls. - ```yaml Type: Int32 Parameter Sets: Weekly, Daily Aliases: every -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -288,15 +295,16 @@ Accept wildcard characters: False ``` ### -CrawlScheduleStartDateTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the initial date of the crawl. The default value is midnight on the current day. - ```yaml Type: DateTime Parameter Sets: MonthlyDate, Weekly, Daily Aliases: start -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -306,14 +314,15 @@ Accept wildcard characters: False ``` ### -CustomProtocol -Specifies the custom protocol, handled by the custom connector, to use for this content source. +> Applicable: SharePoint Server Subscription Edition + +Specifies the custom protocol, handled by the custom connector, to use for this content source. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -323,14 +332,15 @@ Accept wildcard characters: False ``` ### -DailyCrawlSchedule -Base schedule on days between crawls. +> Applicable: SharePoint Server Subscription Edition + +Base schedule on days between crawls. ```yaml Type: SwitchParameter Parameter Sets: Daily Aliases: daily -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -340,14 +350,15 @@ Accept wildcard characters: False ``` ### -EnableContinuousCrawls -Specifies the value of the EnableContinuousCrawls parameter: True or False. +> Applicable: SharePoint Server Subscription Edition + +Specifies the value of the EnableContinuousCrawls parameter: True or False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -357,16 +368,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl content source to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a ContentSource object (for example, ContentSource1); or an instance of a valid ContentSource object. - ```yaml Type: ContentSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -376,14 +388,15 @@ Accept wildcard characters: False ``` ### -LOBSystemSet -Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source. +> Applicable: SharePoint Server Subscription Edition + +Specifies a comma-separated list of Business Data Connectivity Metadata Store system names and system instance names for a business type content source. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -393,14 +406,15 @@ Accept wildcard characters: False ``` ### -MaxPageEnumerationDepth -Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. +> Applicable: SharePoint Server Subscription Edition + +Specifies, for a web or custom type content source, the number of page hops that the crawler can make from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -410,14 +424,15 @@ Accept wildcard characters: False ``` ### -MaxSiteEnumerationDepth -Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. +> Applicable: SharePoint Server Subscription Edition + +Specifies, for a web or custom type content source, the number of site hops that the crawler can take from the start address to a content item. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -427,14 +442,15 @@ Accept wildcard characters: False ``` ### -MonthlyCrawlSchedule -Base the schedule on months between crawls. +> Applicable: SharePoint Server Subscription Edition + +Base the schedule on months between crawls. ```yaml Type: SwitchParameter Parameter Sets: MonthlyDate Aliases: monthly -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -444,16 +460,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new display name for the content source. The type must be a valid name of a content source; for example, ContentSource1. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -463,14 +480,15 @@ Accept wildcard characters: False ``` ### -RemoveCrawlSchedule -Deletes the specified crawl. +> Applicable: SharePoint Server Subscription Edition + +Deletes the specified crawl. ```yaml Type: SwitchParameter Parameter Sets: RemoveSchedule -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -480,17 +498,18 @@ Accept wildcard characters: False ``` ### -ScheduleType + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of crawl schedule. The type must be one of the following values: Full or Incremental. - ```yaml Type: ContentSourceCrawlScheduleType -Parameter Sets: MonthlyDate, Weekly, RemoveSchedule -Aliases: +Parameter Sets: Daily, MonthlyDate, Weekly, RemoveSchedule +Aliases: Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -499,31 +518,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: ContentSourceCrawlScheduleType -Parameter Sets: Daily -Aliases: -Accepted values: Full, Incremental, Full, Incremental -Applicable: SharePoint Server Subscription Edition +### -SearchApplication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -SearchApplication Specifies the search application that contains the content source. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -533,16 +539,17 @@ Accept wildcard characters: False ``` ### -StartAddresses + +> Applicable: SharePoint Server Subscription Edition + Specifies the comma-separated list of URLs at which to start a crawl for this content source. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -552,17 +559,18 @@ Accept wildcard characters: False ``` ### -Tag + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL for the page to modify the settings for a custom content source. The string that specifies the URL can contain a maximum of 1,024 characters. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -572,14 +580,15 @@ Accept wildcard characters: False ``` ### -WeeklyCrawlSchedule -Base the schedule on weeks between crawls. +> Applicable: SharePoint Server Subscription Edition + +Base the schedule on weeks between crawls. ```yaml Type: SwitchParameter Parameter Sets: Weekly Aliases: weekly -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -589,15 +598,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlDatabase.md index beb6a68c0..9c6befe14 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a crawl database for a Search service application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ A crawl database stores crawl history for a Search service application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer @@ -40,10 +38,12 @@ Set-SPEnterpriseSearchCrawlDatabase -Identity SearchApp_CrawlStore -SearchApplic This example sets the failover database server for the crawl database, SearchApp_CrawlStore, to the \\\\failoverServer server. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl database to modify. A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid CrawlStore object. @@ -51,8 +51,7 @@ A valid crawl database name, in the form CrawlStore1; or a valid GUID, such as 1 ```yaml Type: CrawlStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,15 +85,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -102,13 +104,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server to be used for failover when SQL Server mirroring is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +122,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application to which the crawl database applies. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -125,8 +132,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,13 +161,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to create for the crawl database. The type must be a valid name of a SQL Server database; for example, CrawlStoreDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,13 +179,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the Microsoft SQL Server database server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,13 +197,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,13 +215,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the account name on the Database Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlLogReadPermission.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlLogReadPermission.md index dad1bd35a..888fac15f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlLogReadPermission.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlLogReadPermission.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Grants users permission to view the crawl log information. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The administrator can choose to restrict the permission to crawl log information For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $crawlLogPermission = Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant "00000000-0000-0000-0000-000000000001" @@ -42,10 +40,12 @@ Set-SPEnterpriseSearchCrawlLogReadPermission -Identity $crawlLogPermission -Sear This example first defines $crawlLogPermission, which is the list of users who have permission to view the crawl log information from the tenant with id "00000000-0000-0000-0000-000000000001" on the search application referenced by $ssa. Then the example uses the `Set-SPEnterpriseSearchCrawlLogReadPermission` cmdlet to add user1 and user2 to the list of users referenced by $crawlLogPermission. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,8 +57,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -75,7 +77,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -85,13 +86,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawl log permissions list to which users should be added. ```yaml Type: CrawlLogReadPermissionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,14 +104,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the crawl log. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,14 +123,16 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the users shall be added to the crawl log permissions list within the scope of this tenant only. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,14 +142,16 @@ Accept wildcard characters: False ``` ### -UserNames + +> Applicable: SharePoint Server Subscription Edition + Specifies the user names that shall be granted permission to view the crawl log information Use "domain\username" or "username". When adding several user names, separate names with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlRule.md index 7145084b7..7787db6c5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchCrawlRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties for a crawl rule. - ## SYNTAX ``` @@ -29,10 +28,9 @@ A search administrator runs the `Set-SPEnterpriseSearchCrawlRule` cmdlet at init For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $crawlRule = Get-SPEnterpriseSearchCrawlRule -Identity 'file://fileserver/root' -SearchApplication $ssa @@ -41,17 +39,18 @@ Set-SPEnterpriseSearchCrawlRule -Identity $crawlRule -Type "ExclusionRule" This example sets the type of the crawl rule pertaining to the URL, file://fileserver/root, to exclude this path from future crawls. - ## PARAMETERS ### -AccountName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the account to be used to crawl content identified by the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -AccountPassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for AccountName. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,12 +89,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +102,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the following authentication types: - BasicAccountRuleAccess -Specifies basic authentication. @@ -108,12 +113,10 @@ Specifies one of the following authentication types: - NTLMAccountRuleAccess -Specifies the account name for integrated authentication. - ```yaml Type: CrawlRuleAuthenticationType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,15 +126,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,14 +145,15 @@ Accept wildcard characters: False ``` ### -ContentClass -Specifies a string that is sent to the protocol handler for any content that matches the crawl rule. +> Applicable: SharePoint Server Subscription Edition + +Specifies a string that is sent to the protocol handler for any content that matches the crawl rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -158,14 +163,15 @@ Accept wildcard characters: False ``` ### -CrawlAsHttp -Specifies whether the crawler crawls content from a hierarchical content source as HTTP content. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the crawler crawls content from a hierarchical content source as HTTP content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,14 +181,15 @@ Accept wildcard characters: False ``` ### -FollowComplexUrls -Specifies whether the index engine crawls content from URLs that contain a question mark (?). +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the index engine crawls content from URLs that contain a question mark (?). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -192,16 +199,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the crawl rule. The type must be a valid crawl rule URL, such as https://server_name, or an instance of a valid CrawlRule object. - ```yaml Type: CrawlRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -211,16 +219,17 @@ Accept wildcard characters: False ``` ### -IsAdvancedRegularExpression + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the rule has full regular expression syntax. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -230,14 +239,15 @@ Accept wildcard characters: False ``` ### -PluggableSecurityTimmerId -Specifies the ID of the custom pluggable security trimmer to use, if registered. +> Applicable: SharePoint Server Subscription Edition + +Specifies the ID of the custom pluggable security trimmer to use, if registered. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -247,16 +257,17 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server Subscription Edition + Defines where in the list of crawl rules this crawl rule is to be applied. The priority value cannot be less than 0 or greater than or equal to the number of crawl rules for the search application. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -266,16 +277,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + The name of the search application that is associated with the crawl rule to be modified. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -285,14 +297,15 @@ Accept wildcard characters: False ``` ### -SuppressIndexing -Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the crawler excludes the content of items, to which this rule applies, from the content index. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -302,15 +315,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of crawl rule. A value of zero (0) includes the rule and a value of 1 excludes the rule. - ```yaml Type: CrawlRuleType Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -320,15 +334,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchFileFormatState.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchFileFormatState.md index daad7f158..aaf4211da 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchFileFormatState.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchFileFormatState.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the activation state of a parser for a given file format. - ## SYNTAX ``` @@ -29,10 +28,9 @@ The system will only consider the change after a restart of the content processi For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa -Identity PDF -Enable $false @@ -40,18 +38,18 @@ Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa -Identity PDF -Ena This example uses the `Set-SPEnterpriseSearchFileFormatState` cmdlet to disable the parser for the file format "PDF". - ## PARAMETERS ### -Identity -Specifies the identification of the format to be disabled or enabled. +> Applicable: SharePoint Server Subscription Edition + +Specifies the identification of the format to be disabled or enabled. ```yaml Type: DocumentParserFileFormatStatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,15 +59,16 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Specifies the activation state of the parser that corresponds to the specified file format. The activation state can be $FALSE (disabled) or $TRUE (enabled). - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -79,15 +78,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -97,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -136,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -143,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,13 +159,15 @@ Accept wildcard characters: False ``` ### -UseIFilter + +> Applicable: SharePoint Server Subscription Edition + Specifies use of a third-party iFilter when parsing the file format. UseIFilter can be $false (built-in format handler is used) or $TRUE (third-party iFilter is used). $false is the default value. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinguisticComponentsStatus.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinguisticComponentsStatus.md index 3186a18dc..b93283e4a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinguisticComponentsStatus.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinguisticComponentsStatus.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the operation status of the linguistic query and document processing components. - ## SYNTAX ``` @@ -28,10 +27,9 @@ This cmdlet sets the operational status of the linguistic query and document pro For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -StemmingEnabled $false @@ -39,8 +37,7 @@ Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -Stemmi This example shows how to disable stemming during query processing by setting the parameter StemmingEnabled to false. - -### ------------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -AllEnabled $false @@ -48,18 +45,18 @@ Set-SpEnterpriseSearchLinguisticComponentsStatus -SearchApplication $ssa -AllEna This example shows how to disable all linguistic query and document processing functionalities. - ## PARAMETERS ### -AllEnabled -A Boolean value to enable or deactivate all linguistic functionalities. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate all linguistic functionalities. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -69,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -77,12 +77,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,14 +90,15 @@ Accept wildcard characters: False ``` ### -EntityExtractionEnabled -A Boolean value to enable or deactivate the company extractor and all custom extractors during document processing. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate the company extractor and all custom extractors during document processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,14 +108,15 @@ Accept wildcard characters: False ``` ### -Identity -An object that represents the current status of the linguistic components. +> Applicable: SharePoint Server Subscription Edition + +An object that represents the current status of the linguistic components. ```yaml Type: LinguisticComponentsStatusPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,14 +126,15 @@ Accept wildcard characters: False ``` ### -QuerySpellingEnabled -A Boolean value to enable or deactivate query spelling correction. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate query spelling correction. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,14 +144,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the linguistic processing components. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search service application that contains the linguistic processing components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -160,14 +162,15 @@ Accept wildcard characters: False ``` ### -StemmingEnabled -A Boolean value to enable or deactivate expansive stemming during query processing. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate expansive stemming during query processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,14 +180,15 @@ Accept wildcard characters: False ``` ### -ThesaurusEnabled -A Boolean value to enable or deactivate thesaurus lookup during query processing. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate thesaurus lookup during query processing. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinksDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinksDatabase.md index c001bfcd3..9980a4e24 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinksDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchLinksDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a links database for a search service application. - ## SYNTAX ``` @@ -29,10 +28,9 @@ A links database stores query logging and analytics information. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp Set-SPEnterpriseSearchLinksDatabase -Identity SearchApp_LinksStore -SearchApplication $ssa -FailoverDatabaseServer \\failoverServer @@ -40,18 +38,19 @@ Set-SPEnterpriseSearchLinksDatabase -Identity SearchApp_LinksStore -SearchApplic This example sets the failover database server to \\\\failoverServer for the links database SearchApp_LinksStore in the search service application mySearchServiceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the links database to modify. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a LinksStore object, in the form LinksStore1; or an instance of a valid LinksStore object. ```yaml Type: LinksStorePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,13 +103,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the links database name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the account to connect to the database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,13 +139,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server to use for the host SQL database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the account to connect to the database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,13 +175,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the server to use for failover when using SQL Server mirroring. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,14 +193,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the links database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -197,6 +212,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -204,7 +222,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCategory.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCategory.md index e43abea64..661378f6a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCategory.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCategory.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a crawled property category. - ## SYNTAX ``` @@ -31,10 +30,9 @@ Changes to the category will overwrite all propsets. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $ssa -DiscoverNewProperties $false -MapToContents $false @@ -42,10 +40,12 @@ Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $ssa This example sets both DiscoverNewProperties and MapToContents properties to False for the People category for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -54,12 +54,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -69,17 +67,18 @@ Accept wildcard characters: False ``` ### -AutoCreateNewManagedProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: auto -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -89,15 +88,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -107,17 +107,18 @@ Accept wildcard characters: False ``` ### -DiscoverNewProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,16 +128,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata category to update. The type must be a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object. - ```yaml Type: CategoryPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -146,17 +148,18 @@ Accept wildcard characters: False ``` ### -MapToContents + +> Applicable: SharePoint Server Subscription Edition + Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: m -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -166,6 +169,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the enterprise search metadata category. The type must be a valid name of a metadata category, for example MetadataCategory1. @@ -173,12 +179,10 @@ The type must be a valid name of a metadata category, for example MetadataCatego Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -188,16 +192,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the enterprise search metadata categories. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -207,15 +212,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCrawledProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCrawledProperty.md index 1507d72b1..a40a8b64a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCrawledProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataCrawledProperty.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a metadata crawled property. - ## SYNTAX ``` @@ -26,10 +25,9 @@ SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $crawlprop = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $ssa -Name MyCrawlProp @@ -38,10 +36,12 @@ Set-SPEnterpriseSearchMetadataCrawledProperty -Identity $crawlprop -IsMappedToCo This example sets the IsMappedToContent parameter of the crawled property MyCrawlProp to false (see the example for the `New-SPEnterpriseSearchMetadataCrawledProperty` command) for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,12 +50,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -65,15 +63,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -83,16 +82,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawled property to update. The type must be an instance of a valid CrawledProperty object. - ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,15 +102,16 @@ Accept wildcard characters: False ``` ### -IsMappedToContents + +> Applicable: SharePoint Server Subscription Edition + Specifies that the crawled property is mapped to managed properties. Specify true to map a crawled property to a managed property. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -120,15 +121,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataManagedProperty.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataManagedProperty.md index 755699e5f..688791872 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataManagedProperty.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataManagedProperty.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a metadata managed property. - ## SYNTAX ``` @@ -32,10 +31,9 @@ SPEnterpriseSearchMetadataManagedProperty represents a managed property in the e For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity UserName -EnabledForScoping $true @@ -43,10 +41,12 @@ Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa -Identity This example sets the EnabledForScoping property to true for the managed property named UserName in the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,12 +55,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -70,15 +68,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,17 +87,18 @@ Accept wildcard characters: False ``` ### -DefaultForQueryIndependentRank + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property is mandatory when it is used in query-independent rank (relevance). Note: Null indicates that the value is unchanged. - ```yaml Type: UInt32 Parameter Sets: (All) Aliases: def -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -108,18 +108,19 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Adds a description to the metadata managed property. The type must be a valid string. Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -129,6 +130,9 @@ Accept wildcard characters: False ``` ### -EnabledForQueryIndependentRank + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking. The type must be one of the following query-independent ranking features in the custom model XML: @@ -139,12 +143,10 @@ The type must be one of the following query-independent ranking features in the Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: qir -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -154,16 +156,17 @@ Accept wildcard characters: False ``` ### -EnabledForScoping + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property can be used in a scope definition. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -173,16 +176,17 @@ Accept wildcard characters: False ``` ### -FullTextQueriable + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property can be used in enterprise search SQL queries. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -192,16 +196,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to update. The type must be a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object - ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -211,13 +216,15 @@ Accept wildcard characters: False ``` ### -IncludeInAlertSignature + +> Applicable: SharePoint Server Subscription Edition + Specifies whether this managed property should be included in alert signature. ```yaml Type: Boolean Parameter Sets: (All) Aliases: ia -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -227,16 +234,17 @@ Accept wildcard characters: False ``` ### -IncludeInMd5 + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: im5 -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -246,18 +254,19 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a name for the managed property. The type must be a valid managed property name, for example ManagedProperty1. Note: Null indicates that the value is unchanged. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -267,17 +276,18 @@ Accept wildcard characters: False ``` ### -NameNormalized + +> Applicable: SharePoint Server Subscription Edition + Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. If value is set to true, the values are normalized. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nn -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -287,16 +297,17 @@ Accept wildcard characters: False ``` ### -NoWordBreaker + +> Applicable: SharePoint Server Subscription Edition + Specifies that the values for this managed property are processed by a word breaker. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: nw -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -306,14 +317,15 @@ Accept wildcard characters: False ``` ### -RemoveDuplicates -Specifies that duplicate values for the managed property are removed. +> Applicable: SharePoint Server Subscription Edition + +Specifies that duplicate values for the managed property are removed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: rd -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -323,17 +335,18 @@ Accept wildcard characters: False ``` ### -RespectPriority -Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. + +> Applicable: SharePoint Server Subscription Edition + +Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. Otherwise, all mapped crawled properties that have a value are copied. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: rp -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -343,16 +356,17 @@ Accept wildcard characters: False ``` ### -Retrievable + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the values for this managed property are retrievable or not. Note: Null indicates that the value is unchanged. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -362,13 +376,15 @@ Accept wildcard characters: False ``` ### -SafeForAnonymous + +> Applicable: SharePoint Server Subscription Edition + Specifies whether it is acceptable to display the contents of the property in search results for anonymous searches. ```yaml Type: Boolean Parameter Sets: (All) Aliases: sfa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -378,16 +394,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the managed property collection. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -397,16 +414,17 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -416,16 +434,17 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the managed properties returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -435,16 +454,17 @@ Accept wildcard characters: False ``` ### -UserFlags + +> Applicable: SharePoint Server Subscription Edition + Reserved for future use. Note: Null indicates that the value is unchanged. - ```yaml Type: Int16 Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -454,15 +474,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataMapping.md index 80c8d8e34..684818d30 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchMetadataMapping.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a managed property mapping for a search service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ SPEnterpriseSearchMetadataMapping represents a mapping between a managed propert For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication ## get the crawl property to set to, in this case a new property is created @@ -48,10 +46,12 @@ Set-SPEnterpriseSearchMetadataMapping -Identity $map -SearchApplication $ssa -Cr This example updates an existing mapping between the managed property UserName and the crawled property MyCrawlProp (see `New-SPEnterpriseSearchMetadataMapping`) for the default search service application. The crawled property is replaced with a new crawled property named MyNewCrawlProp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the metadata mapping to update. The type must be a valid URL, in the form https://server_name, or an instance of a valid Mapping object. @@ -59,8 +59,7 @@ The type must be a valid URL, in the form https://server_name, or an instance of ```yaml Type: MappingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the metadata mapping. The type be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. @@ -77,8 +79,7 @@ The type be a valid search application name, for example, SearchApp1, or an inst ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -CrawledProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the crawled property to map. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form https://server_name, or an instance of a valid CrawledProperty object. @@ -136,8 +144,7 @@ Note: Null indicates that the value is unchanged. ```yaml Type: CrawledPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -ManagedProperty + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed property to receive the crawled property mapping. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. @@ -156,8 +166,7 @@ Note: Null indicates that the value is unchanged. ```yaml Type: ManagedPropertyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -167,6 +176,9 @@ Accept wildcard characters: False ``` ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mappings returned are to be within the scope of a site collection (SPSite). The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -174,8 +186,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -185,6 +196,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: SharePoint Server Subscription Edition + Specifies that the metadata mappings returned are to be within the scope of a tenant. The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -192,8 +206,7 @@ The type must be a valid GUID that specifies the property set in the form 123456 ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -203,6 +216,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -210,7 +226,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchPrimaryHostController.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchPrimaryHostController.md index 7104186b7..09a73c117 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchPrimaryHostController.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchPrimaryHostController.md @@ -24,12 +24,11 @@ This cmdlet sets the primary SearchHostController for the farm to the defined Se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell -$si = Get-SPEnterpriseSearchServiceInstance -Local +$si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchPrimaryHostController $si ``` @@ -38,10 +37,9 @@ It is up to the user to select the HostController with latest version available. If you choose a SearchHostController that is not running the latest version of the repository, you will have to confirm before you continue. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell -$si = Get-SPEnterpriseSearchServiceInstance -Local +$si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchPrimaryHostController $si -Force ``` @@ -49,17 +47,18 @@ This example sets the local SearchHostController instance as the new primary Sea If you choose a SearchHostController that is not running the latest version of the repository, you will not get a confirmation message before you continue. - ## PARAMETERS ### -SearchServiceInstance + +> Applicable: SharePoint Server Subscription Edition + SearchServiceInstance of the server from where the SearchHostController object is returned. ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +82,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -98,7 +102,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -108,14 +111,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Force the change of the primary SearcHostController. No confirmation messages are asked, even if user tries to set primary to a SearchHostController not running the latest version of the repository. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryAuthority.md index 8fef98886..b768790cc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryAuthority.md @@ -26,20 +26,21 @@ SPEnterpriseSearchQueryAuthority represents authoritative sites that rank higher For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPEnterpriseSearchQueryAuthority -Identity https://contoso.com -Level 0.5 -SearchApplication MySSA ``` This example adjusts the authoritative level of the URL https://contoso.com to 0.5 on the search service application named MySSA. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,12 +49,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,15 +62,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -81,16 +81,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the query authority page to update. The type must be a valid URL, in the form https://server_name; or an instance of a valid AuthorityPage object. - ```yaml Type: AuthorityPagePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -100,6 +101,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: SharePoint Server Subscription Edition + Specifies the level of the new authoritative page. Authoritative pages, designated by the service application administrator, are expert pages that link to the most relevant information. Because a search service application can have several designated authoritative pages, you use the Level property to specify the value of a specific page. @@ -107,12 +111,10 @@ This parameter sets the level for the most valuable authoritative pages to 0. The type must be one of the following floating-point numbers: 0, 1, or 2. - ```yaml Type: Single Parameter Sets: (All) Aliases: l -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -122,14 +124,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription +> Applicable: SharePoint Server Subscription Edition + +Specifies the search object owner that defines the scope at which the corresponding Query Authority is created. The owner must be one of the following valid levels:- Search Service Application- Site Subscription ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -139,16 +142,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the authority page collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -158,15 +162,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryKeyword.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryKeyword.md index ea578e789..8497b66df 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryKeyword.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryKeyword.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a keyword term for a shared search application. - ## SYNTAX ``` @@ -31,20 +30,21 @@ You can use this cmdlet for keywords in site collections that are in SharePoint For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchQueryKeyword -Identity Engineering -Site https://myserver/sites/engineering | Set-SPEnterpriseSearchQueryKeyword -StartDate "12/25/2009" -EndDate "12/24/2010" -Site https://myserver/sites/engineering ``` This example gets a reference to the keyword with the term Engineering from the site https://myserver/sites/engineering and sets the start dates and end dates for the keyword. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,12 +53,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -68,15 +66,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -86,16 +85,17 @@ Accept wildcard characters: False ``` ### -Contact + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name associated with the new keyword. The type must be a valid user name; for example, KeywordUser1. - ```yaml Type: String Parameter Sets: (All) Aliases: c -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,16 +105,17 @@ Accept wildcard characters: False ``` ### -Definition + +> Applicable: SharePoint Server Subscription Edition + Specifies the definition of the new keyword term. The type must be a valid string; for example, a keyword term definition. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,17 +125,18 @@ Accept wildcard characters: False ``` ### -EndDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: e -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -144,16 +146,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the keyword term to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that contains a keyword term (for example, KeywordTerm1); or an instance of a valid Keyword object. - ```yaml Type: KeywordPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -163,17 +166,18 @@ Accept wildcard characters: False ``` ### -ReviewDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the review date of the keyword term. The default value is MaxDate. The type must be a valid DateTime type, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: r -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -183,16 +187,17 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Associates the new keyword term to the specified results URL. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. - ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -202,17 +207,18 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: SharePoint Server Subscription Edition + Specifies the activation date for the keyword term. The default value is the current date. The type must be a valid date, in the form 2010,12,05. - ```yaml Type: DateTime Parameter Sets: (All) Aliases: s -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -222,16 +228,17 @@ Accept wildcard characters: False ``` ### -Term + +> Applicable: SharePoint Server Subscription Edition + Specifies the keyword term that triggers keyword results. The type must be a valid string; for example, a keyword term. - ```yaml Type: String Parameter Sets: (All) Aliases: t -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -241,15 +248,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScope.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScope.md index 7397e68e2..26ff7f802 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScope.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScope.md @@ -34,10 +34,9 @@ SPEnterpriseSearchQueryScope represents a query results scope used by all shared For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPenterpriseSearchServiceApplication Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage https://altServer @@ -45,20 +44,20 @@ Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | S This example obtains a reference to the scope named MustCrawl on the search service application named MySSA and changes the description, compilation type and alternate access URL. - ## PARAMETERS ### -AlternateResultsPage + +> Applicable: SharePoint Server Subscription Edition + Specifies the location to display results for the new query scope. The type must be a valid URL, in the form https://server_name. - ```yaml Type: String Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -68,6 +67,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,12 +78,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,17 +91,18 @@ Accept wildcard characters: False ``` ### -CompilationType + +> Applicable: SharePoint Server Subscription Edition + Specifies the compilation type of the new scope. The value 0 specifies the conditionally compiled scope type, and the value 1 specifies the always compiled scope type. The type must be either of the following: 0 or 1. - ```yaml Type: Int32 Parameter Sets: (All) Aliases: type -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,15 +112,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -129,16 +131,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Adds a description of the new query scope. The type must be a valid string; for example, a description of a query scope. - ```yaml Type: String Parameter Sets: (All) Aliases: d -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,15 +151,16 @@ Accept wildcard characters: False ``` ### -DisplayInAdminUI + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new scope is displayed in the administration application user interface (UI). The default setting is to hide the new scope in the administration application UI. - ```yaml Type: Boolean Parameter Sets: (All) Aliases: disp -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -166,16 +170,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the scope to create. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. - ```yaml Type: ScopePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -185,16 +190,17 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a name for the query scope. The type must be a valid name of a query scope; for example, QueryScope1. - ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -204,16 +210,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -223,16 +230,17 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Filters to delete scopes for the specified results URL. The type must be a valid URL, in the form https://server_name. - ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -242,15 +250,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScopeRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScopeRule.md index ac6f1b5f8..d46740389 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScopeRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQueryScopeRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a shared scope rule for a query scope. - ## SYNTAX ``` @@ -36,10 +35,9 @@ SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa @@ -48,10 +46,12 @@ Get-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url https://criticalSite | S This example gets a reference to a scope rule for the URL https://criticalSite and sets its rule type to Url. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope rule to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance a valid ScopeRule object. @@ -59,8 +59,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: ScopeRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +69,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the results URL that is associated with the query scope rule. The type must be a valid URL, in the form https://server_name. @@ -78,7 +80,6 @@ The type must be a valid URL, in the form https://server_name. Type: Uri Parameter Sets: (All) Aliases: u -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -99,8 +103,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -117,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -127,6 +132,9 @@ Accept wildcard characters: False ``` ### -FilterBehavior + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of scope rule to create for the query scope. The type must be one of the following values: Exclude, Include, or Require. @@ -135,7 +143,6 @@ The type must be one of the following values: Exclude, Include, or Require. Type: String Parameter Sets: (All) Aliases: f -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -145,6 +152,9 @@ Accept wildcard characters: False ``` ### -ManagedPropertyName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the managed property to use for the PropertyQuery scope rule. The type must be a valid name of a managed property; for example, ManagedProp1. @@ -153,7 +163,6 @@ The type must be a valid name of a managed property; for example, ManagedProp1. Type: String Parameter Sets: (All) Aliases: mname -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,13 +172,15 @@ Accept wildcard characters: False ``` ### -MatchingString + +> Applicable: SharePoint Server Subscription Edition + Specifies the string to use when matching the URL rule type. ```yaml Type: String Parameter Sets: (All) Aliases: text -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -179,13 +190,15 @@ Accept wildcard characters: False ``` ### -PropertyValue + +> Applicable: SharePoint Server Subscription Edition + Specifies the property value to use when matching the PropertyQuery rule type. ```yaml Type: String Parameter Sets: (All) Aliases: value -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -195,6 +208,9 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: SharePoint Server Subscription Edition + Applies the query scope rule to the specified scope. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object. @@ -203,7 +219,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: ScopePipeBind Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -213,6 +228,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the query scope rule collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -220,8 +238,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -231,6 +248,9 @@ Accept wildcard characters: False ``` ### -UrlScopeRuleType + +> Applicable: SharePoint Server Subscription Edition + Specifies the value to use when matching the URL rule type. The type must be one of the following values: Folder, HostName, or Domain. @@ -239,7 +259,6 @@ The type must be one of the following values: Folder, HostName, or Domain. Type: String Parameter Sets: (All) Aliases: ut -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -249,6 +268,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -256,7 +278,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQuerySpellingCorrection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQuerySpellingCorrection.md index 72d5e2d1c..9328260c7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQuerySpellingCorrection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchQuerySpellingCorrection.md @@ -30,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------- +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Set-SpEnterpriseSEarchQuerySpellingCorrection -SearchApplication $ssa -SpellingDictionary dynamic @@ -38,10 +38,12 @@ Set-SpEnterpriseSEarchQuerySpellingCorrection -SearchApplication $ssa -SpellingD This example sets the dictionary named dynamic to be used for query spelling correction for the default search service application. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,12 +52,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -65,14 +65,15 @@ Accept wildcard characters: False ``` ### -ContentAlignmentEnabled -A Boolean value to enable or deactivate the content alignment process. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate the content alignment process. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,15 +83,16 @@ Accept wildcard characters: False ``` ### -DiacriticsInSuggestionsEnabled -A switch to enable or disable spelling suggestions that contain diacritics (for example, German umlaut umlaut). -The default setting is true. +> Applicable: SharePoint Server Subscription Edition + +A switch to enable or disable spelling suggestions that contain diacritics (for example, German umlaut umlaut). +The default setting is true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,14 +102,15 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an object that represents the current status for the query spelling correction. +> Applicable: SharePoint Server Subscription Edition + +Specifies an object that represents the current status for the query spelling correction. ```yaml Type: QuerySpellingCorrectionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,15 +120,16 @@ Accept wildcard characters: False ``` ### -MaxDictionarySize + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximal number of terms in a content-aligned spelling dictionary. In a multi-tenant environment, this number is valid per tenant. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,15 +139,16 @@ Accept wildcard characters: False ``` ### -MaxProcessingTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum runtime for compiling a content-aligned spelling dictionary. The default value is 6 hours. - ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,14 +158,15 @@ Accept wildcard characters: False ``` ### -SearchApplication -Specifies the search service application that contains the QSC components. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search service application that contains the QSC components. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -170,15 +176,16 @@ Accept wildcard characters: False ``` ### -SecurityTrimmingEnabled -A Boolean value to enable or deactivate the security check for spelling suggestions. -If enabled, only spelling suggestions that deliver at least one document for the current user are shown. +> Applicable: SharePoint Server Subscription Edition + +A Boolean value to enable or deactivate the security check for spelling suggestions. +If enabled, only spelling suggestions that deliver at least one document for the current user are shown. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,17 +195,18 @@ Accept wildcard characters: False ``` ### -SpellingDictionary + +> Applicable: SharePoint Server Subscription Edition + Specifies the dictionary to be used for query spelling correction. The two available values are dynamic and static. When value is set to dynamic, the query spelling correction uses the content-aligned dictionary. When value is set to static, the query spelling correction uses the out of the box static spelling dictionaries. - ```yaml Type: SpellingDictionaryType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -208,15 +216,16 @@ Accept wildcard characters: False ``` ### -TermFrequencyThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the minimum number of documents that must contain the most frequently used term in the document collection for the content-alignment process to be executed. In a multi-tenant environment, this number is valid per tenant. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchRankingModel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchRankingModel.md index d025c121d..4b8089649 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchRankingModel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchRankingModel.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a ranking model for a shared search service application. - ## SYNTAX ``` @@ -28,14 +27,13 @@ If the Identity parameter is not specified or the identity does not match any of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level ssa -$rankingModel = Get-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner +$rankingModel = Get-SPEnterpriseSearchRankingModel -Identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 -SearchApplication $ssa -Owner $owner $newrankmodel = Get-Content .\newRankModel.xml $newrankmodel = [String]$newrankmodel Set-SPEnterpriseSearchRankingModel -Identity $rankingModel -SearchApplication $ssa -Owner $owner -RankingModelXML $newrankmodel @@ -43,10 +41,12 @@ Set-SPEnterpriseSearchRankingModel -Identity $rankingModel -SearchApplication $s This example reconfigures the ranking model with the identity 8f6fd0bc-06f9-43cf-bbab-08c377e083f4 with the new ranking model specified in newRankModel.xml. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the ranking model to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid RankingModel object. @@ -54,8 +54,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: RankingModelPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the scope where the ranking model is available. The available scopes are: SSA, Tenant, Site Collection or Site. A ranking model can be available in multiple scopes. @@ -73,7 +75,6 @@ A ranking model can be available in multiple scopes. Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -RankingModelXML + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the XML representation of the new ranking model. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +116,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,6 +126,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,6 +145,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application that contains the ranking model. The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a valid search application name (for example, SearchApp1), or an instance of a valid SearchServiceApplication object. @@ -145,8 +155,7 @@ The type must be a valid GUID in the 9bf36458-fc99-4f7b-b060-867e5a63adce, a val ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -163,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultItemType.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultItemType.md index 3d631dbe1..db7e9508c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultItemType.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultItemType.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a result item type. - ## SYNTAX ``` @@ -42,10 +41,9 @@ Example use cases: For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $web = Get-SPWeb https://webUrl $tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web @@ -58,12 +56,12 @@ $ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection $ruleCollection.Add($rule) $displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime" $displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js" -Set-SPEnterpriseSearchResultItemType +Set-SPEnterpriseSearchResultItemType -Identity $resultType ` -SearchApplication $ssa ` -Name "CustomResultType" ` -Rules $ruleCollection ` --RulePriority 1 +-RulePriority 1 -DisplayProperties $displayProperties ` -DisplayTemplateUrl $displaytemplateUrl ` -Owner $tenantOwner @@ -79,18 +77,19 @@ Next, the example defines which properties of the result item type that shall be Finally, the example uses the `Set-SPEnterpriseSearchResultItemType` cmdlet to modify the result item type. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result item type to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: ResultItemTypePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -100,13 +99,15 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: SharePoint Server Subscription Edition + Specifies the search object owner that defines the scope at which the result item type was created. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -116,6 +117,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -127,8 +131,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +141,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -155,13 +160,15 @@ Accept wildcard characters: False ``` ### -DisplayProperties + +> Applicable: SharePoint Server Subscription Edition + Specifies which result properties to display. ```yaml Type: String Parameter Sets: (All) Aliases: dp -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -171,13 +178,15 @@ Accept wildcard characters: False ``` ### -DisplayTemplateUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the display template that shall be used for rendering the results. ```yaml Type: String Parameter Sets: (All) Aliases: url -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -187,13 +196,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the result item type. ```yaml Type: String Parameter Sets: (All) Aliases: n -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -203,13 +214,15 @@ Accept wildcard characters: False ``` ### -OptimizeForFrequentUse + +> Applicable: SharePoint Server Subscription Edition + {{ Fill OptimizeForFrequentUse Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: opt -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -219,13 +232,15 @@ Accept wildcard characters: False ``` ### -RulePriority + +> Applicable: SharePoint Server Subscription Edition + Specifies which priority the collection of rules has compared to other rules. ```yaml Type: Int32 Parameter Sets: (All) Aliases: priority -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -235,13 +250,15 @@ Accept wildcard characters: False ``` ### -Rules + +> Applicable: SharePoint Server Subscription Edition + Specifies the collection of rules to evaluate the result properties against. ```yaml Type: PropertyRuleCollection Parameter Sets: (All) Aliases: rule -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -251,14 +268,16 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -268,14 +287,16 @@ Accept wildcard characters: False ``` ### -SearchApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the search application that contains the result item type. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application proxy name (for example, SearchAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -285,13 +306,15 @@ Accept wildcard characters: False ``` ### -SourceID + +> Applicable: SharePoint Server Subscription Edition + Identifies the search result source that the result item type applies to. ```yaml Type: Guid Parameter Sets: (All) Aliases: sid -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -301,6 +324,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -308,7 +334,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultSource.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultSource.md index a43bb4fae..e64f34bce 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultSource.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchResultSource.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a result source. - ## SYNTAX ``` @@ -30,10 +29,9 @@ This cmdlet supports the same update operations as are supported through the "Ma The result source cannot be a built-in source (a built-in source has the BuiltIn property set to true) for any update operation other than changing the default result source using the MakeDefault parameter. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -41,11 +39,10 @@ $customResultSource = New-SPEnterpriseSearchResultSource -SearchApplication $ssa Set-SPEnterpriseSearchResultSource -Identity $customResultSource -Name "Basic SharePoint Result Source" ``` -This example updates the name of the result source and the identity of the result source is specified as a result source instance. +This example updates the name of the result source and the identity of the result source is specified as a result source instance. SearchApplication and Owner are not required for this update operation. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $owner = Get-SPEnterpriseSearchOwner -Level SSA @@ -55,24 +52,24 @@ Set-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner -Identi This example updates the description of the result source and the identity of the result source is specified by name. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - + When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +79,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType + +> Applicable: SharePoint Server Subscription Edition + Specifies an authentication type for the result source. If parameter is not specified, the value is unchanged. A specific set of authentication types are supported for each search provider type and if parameter is not specified, the authentication type will default based on search provider type. @@ -92,16 +92,14 @@ When using a Local SharePoint Search/Local SharePoint People Search provider, th When using a Remote SharePoint Search/Remote SharePoint People Search provider, then FederationAuthType.PerUserBasicAuth (default) and FederationAuthType.SSO are supported. -When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. +When using OpenSearch 1.0/1.1 search provider, then the following authentication types are supported: FederationAuthType.Anonymous (default), FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest, FederationAuthType.SingleAccountNTLM, and FederationAuthType.ApplicationPoolIdentity. All authentication types are listed in the enum FederationAuthType. - ```yaml Type: FederationAuthType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +109,9 @@ Accept wildcard characters: False ``` ### -AutoDiscover + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to use automatic discovery of the Exchange server endpoint for the result source. Setting value to true ($true) states that automatic discovery should be used. @@ -119,12 +120,10 @@ If parameter is not specified, the value is unchanged. Only applicable when using an Exchange search provider. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,15 +133,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -152,16 +152,17 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies a description for the result source. If parameter is not specified, the value is unchanged. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,16 +172,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the result source to update. The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Custom SharePoint Result Source"); or an instance of a valid Source object. - ```yaml Type: ResultSourcePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -190,22 +192,23 @@ Accept wildcard characters: False ``` ### -MakeDefault + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the result source should be set as default result source or not, for the scope specified by the Owner parameter. If parameter is not specified, the default result source will not change. Setting value to true ($true) states that the result source should be set as default. -Setting value to false ($false) states that the result source should not be set as default and in this case, if the result source to update is currently the default, the original default result source ("Local SharePoint Results") will be set as default again. +Setting value to false ($false) states that the result source should not be set as default and in this case, if the result source to update is currently the default, the original default result source ("Local SharePoint Results") will be set as default again. Tip: Use instance, not name or GUID string Id, as Identity when using Makedefault, to clearly specify that Owner is only to be used for specifying the level where the result source should be set as default (if value is true) or where the default should be reset to original (if value is false). - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -215,6 +218,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies a name for the result source. If parameter is not specified, the value is unchanged. @@ -223,12 +229,10 @@ Names must be unique at each administrative level. For example, two result sources in a site cannot share a name, but one in a site and one provided by the site collection can. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -238,14 +242,15 @@ Accept wildcard characters: False ``` ### -Owner -Specifies the search object owner that defines the scope at which the corresponding result source is available. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search object owner that defines the scope at which the corresponding result source is available. ```yaml Type: SearchObjectOwner Parameter Sets: (All) Aliases: o -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -255,18 +260,19 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server Subscription Edition + Specifies the password of the user credentials to use to connect to the result source. If parameter is not specified, the value is unchanged. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -276,18 +282,19 @@ Accept wildcard characters: False ``` ### -ProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies a search provider to be used by the result source. If parameter is not specified, the value is unchanged. Is specified as a Guid or GUID string, which must be one of the following: FA947043-6046-4F97-9714-40D4C113963D (Local SharePoint Search), E4BCC058-F133-4425-8FFC-1D70596FFD33 (Local SharePoint People Search), 1E0C8601-2E5D-4CCB-9561-53743B5DBDE7 (Remote SharePoint Search), E377CAAA-FCAF-4a1b-B7A1-E69A506A07AA (Remote SharePoint People Search), 3A17E140-1574-4093-BAD6-E19CDF1C0122 (Exchange Search), 3A17E140-1574-4093-BAD6-E19CDF1C0121 (OpenSearch 1.0/1.1). - ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -297,6 +304,9 @@ Accept wildcard characters: False ``` ### -QueryTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies the query transformation template of the result source. If parameter is not specified, the value is unchanged. @@ -309,12 +319,10 @@ For example, to only return OneNote items, set the new text to "{searchTerms} fi Then, an incoming query "sharepoint" becomes "sharepoint fileextension=one". Default value is {searchTerms}. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -324,13 +332,16 @@ Accept wildcard characters: False ``` ### -RemoteUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies a connection URL template for the result source. If parameter is not specified, the value is unchanged. Must be set when using a search provider that consumes it: Remote SharePoint Search, Remote SharePoint People Search, OpenSearch 1.0/1.1, and Exchange (if AutoDiscover is not turned on). -When using other search providers the parameter is ignored. +When using other search providers the parameter is ignored. For Remote SharePoint Search/Remote SharePoint People Search, specify the address of the root site collection of the remote SharePoint farm. @@ -339,12 +350,10 @@ For OpenSearch 1.0/1.1, specify the URL of the OpenSearch source. Include the query in the URL by using the query variable "{searchTerms}", which will be automatically replaced with the query. For Exchange, specify the Exchange EWS URL from which to retrieve results. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -354,16 +363,17 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -373,6 +383,9 @@ Accept wildcard characters: False ``` ### -SsoId + +> Applicable: SharePoint Server Subscription Edition + Specifies the reverse proxy certificate Secure Store Id to use to connect to the result source. If parameter is not specified, the value is unchanged. @@ -381,12 +394,10 @@ Must be specified if authentication type (AUthenticationType) is set to Federati If you are connecting to your intranet through a reverse proxy, enter the SSO Id of the Single Sign On entry which stores the certificate used to authenticate against the reverse proxy. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -396,18 +407,19 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name of the user credentials to use to connect to the result source. If parameter is not specified, the value is unchanged. Used when authentication type (AuthenticationType) is set to a type that consumes user credentials (FederationAuthType.SingleAccountBasicAuth, FederationAuthType.SingleAccountDigest or FederationAuthType.SingleAccountNTLM). - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -417,15 +429,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchService.md index 5aee393c5..3dc25c27a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchService.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a search service for a farm. - ## SYNTAX ``` @@ -28,10 +27,9 @@ This cmdlet updates properties of a search service for a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $password = Read-Host -AsSecureString Set-SPEnterpriseSearchService -IgnoreSSLWarnings $true -ServiceAccount 'contoso\adminAccount' -ServicePassword $password @@ -39,10 +37,12 @@ Set-SPEnterpriseSearchService -IgnoreSSLWarnings $true -ServiceAccount 'contoso\ This example configures the search service to ignore SSL warnings and changes the service account for the search service. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchService1); or an instance of a valid SearchService object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -61,16 +60,17 @@ Accept wildcard characters: False ``` ### -AcknowledgementTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time in seconds that the search server will wait for request acknowledgement while connecting to other services. The type must be string input that can be parsed to an integer value. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -119,16 +123,17 @@ Accept wildcard characters: False ``` ### -ConnectionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time in seconds that the search server waits while connecting to other services. The type must be string input that can be parsed to an integer value. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -ContactEmail + +> Applicable: SharePoint Server Subscription Edition + Specifies an e-mail address to which external site administrators can write if problems occur when the site is being crawled. The type must be a valid e-mail address, in the form MyAddress@mycompany.com. @@ -145,8 +153,7 @@ The type must be a valid e-mail address, in the form MyAddress@mycompany.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,6 +163,9 @@ Accept wildcard characters: False ``` ### -IgnoreSSLWarnings + +> Applicable: SharePoint Server Subscription Edition + Specifies that the search service will ignore Secure Sockets Layer (SSL) certificate name warnings. The default value is False. @@ -164,8 +174,7 @@ The type must be a string that can be cast to a Boolean value, for example, True ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,13 +184,15 @@ Accept wildcard characters: False ``` ### -InternetIdentity + +> Applicable: SharePoint Server Subscription Edition + Specifies the value that the crawler sends in the headers of its HTTP requests to sites when it fetches their pages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,22 +202,23 @@ Accept wildcard characters: False ``` ### -PerformanceLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the relative number of threads for the crawl component performance. The type must be one of the following values: Reduced, PartlyReduced, or Maximum. The default value is Maximum. - + * Reduced: Total number of threads = number of processors, Max Threads/host = number of processors. Threads are assigned Below Normal priority. - + * Partly Reduced: Total number of threads = 16 times the number of processors , Max Threads/host = 8 plus the number of processors. Threads are assigned Below Normal priority. - -* Maximum: Total number of threads = 32 times the number of processors, Max Threads/host = 8 plus the number of processors. Threads are assigned Normal priority. +* Maximum: Total number of threads = 32 times the number of processors, Max Threads/host = 8 plus the number of processors. Threads are assigned Normal priority. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -216,6 +228,9 @@ Accept wildcard characters: False ``` ### -ProxyType + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the search service uses a proxy server or connects directly when crawling content. The default value is Direct, (No proxy server is used). @@ -224,8 +239,7 @@ The type must be one of the following values: Direct or Proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -235,17 +249,18 @@ Accept wildcard characters: False ``` ### -ServiceAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies the user account or service account to use for running the Office Server Search service. When this parameter is used, the ServicePassword parameter must also be specified. The type must be a valid account name on the domain, in the form Domain\user name or user name. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -255,6 +270,9 @@ Accept wildcard characters: False ``` ### -ServicePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the service account specified in ServiceAccount. The type must contain the domain password to the account specified in the ServiceAccount parameter. @@ -262,8 +280,7 @@ The type must contain the domain password to the account specified in the Servic ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -273,6 +290,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -280,7 +300,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplication.md index 01d6d5c8f..323e84eea 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a search service application for a farm. - ## SYNTAX ``` @@ -32,30 +31,29 @@ A search application can include multiple search service applications. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPEnterpriseSearchServiceApplication -Identity "Search Service Application" -VerboseQueryMonitoring True ``` This example turns on verbose query logging in the default search service application named Search Service Application. - ## PARAMETERS ### -AdminApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the application pool for the administrative web service for the search service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AdminAppPool1); or an instance of a valid IISWebServiceApplicationPool object. - ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -65,16 +63,17 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies an application pool for the search service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPool1); or an instance of a valid IISWebServiceApplicationPool object. - ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,6 +83,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,12 +94,10 @@ When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are au When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,15 +107,16 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,15 +126,16 @@ Accept wildcard characters: False ``` ### -DatabaseName -This parameter is obsolete and has no function. -You should not use this parameter. +> Applicable: SharePoint Server Subscription Edition + +This parameter is obsolete and has no function. +You should not use this parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,14 +145,15 @@ Accept wildcard characters: False ``` ### -DatabasePassword -Specifies the password for the user ID that is used for accessing the web service administration database on SQL Server. +> Applicable: SharePoint Server Subscription Edition + +Specifies the password for the user ID that is used for accessing the web service administration database on SQL Server. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -160,16 +163,17 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the web service administration database. The type must be a valid SQL Server host name, for example, SQLServerHost1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,16 +183,17 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user ID to use for accessing the web service administration database. The type must be a valid user name, for example, WebAdminUserDB1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,16 +203,17 @@ Accept wildcard characters: False ``` ### -DefaultContentAccessAccountName + +> Applicable: SharePoint Server Subscription Edition + Specifies the account ID to use for accessing content. The type must be a valid user name, for example, ContentAccessUser1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -217,16 +223,17 @@ Accept wildcard characters: False ``` ### -DefaultContentAccessAccountPassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the content access account. The type must be a valid password. - ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -236,15 +243,16 @@ Accept wildcard characters: False ``` ### -DefaultSearchProvider -Specifies the search application type to be used for this application. -This parameter has been deprecated for SharePoint Server. +> Applicable: SharePoint Server Subscription Edition + +Specifies the search application type to be used for this application. +This parameter has been deprecated for SharePoint Server. ```yaml Type: SearchProvider Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -254,15 +262,16 @@ Accept wildcard characters: False ``` ### -DiacriticSensitive + +> Applicable: SharePoint Server Subscription Edition + Specifies that the search application respects diacritics (for example, ä). The default value is false. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -272,16 +281,17 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL instance for the failover database server. The type must be a valid SQL Server instance name, for example, SQLServerHost1. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -291,16 +301,17 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object. - ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -310,17 +321,18 @@ Accept wildcard characters: False ``` ### -VerboseQueryMonitoring + +> Applicable: SharePoint Server Subscription Edition + Enables verbose query logging. The default value is False. The type must be a string that can be cast to a Boolean value, for example, True or False. - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -330,15 +342,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplicationProxy.md index b054f2151..eddd0d450 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a search service application proxy. - ## SYNTAX ``` @@ -27,20 +26,21 @@ One search service application proxy exists for each search application on a far For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchServiceApplicationProxy -Identity SsaProxy | Set- SPEnterpriseSearchServiceApplicationProxy -Name ContosoSearchProxy ``` This example sets the display name of a search service application proxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specified the search service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search service application proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the search application proxy to retrieve. The type must be a valid string, for example, SearchAppProxy1. @@ -105,8 +111,7 @@ The type must be a valid string, for example, SearchAppProxy1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceInstance.md index b08068357..151164f50 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchServiceInstance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a search service instance. - ## SYNTAX ``` @@ -26,10 +25,9 @@ This cmdlet updates properties of the search service instance for a farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference [https://go.microsoft.com/fwlink/p/?LinkId=671715](https://go.microsoft.com/fwlink/p/?LinkId=671715). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $si = Get-SPEnterpriseSearchServiceInstance -Local Set-SPEnterpriseSearchServiceInstance -Identity $si -DefaultIndexLocation F:\SearchIndex @@ -39,16 +37,17 @@ Sets the default index location to F:\SearchIndex. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. - ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,16 +57,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,14 +77,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +95,9 @@ Accept wildcard characters: False ``` ### -DefaultIndexLocation + +> Applicable: SharePoint Server Subscription Edition + > [!NOTE] > On SharePoint Server 2013 and SharePoint Server 2016, SharePoint Server 2019 this parameter is obsolete and has no function. You should not use this parameter. @@ -105,12 +109,10 @@ The type must be a valid path in either of the following forms: - \\\\server_name\folder_name - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,15 +122,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchTopology.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchTopology.md index 4ee2edf58..56cc3edfd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchTopology.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPEnterpriseSearchTopology.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Activates a given search topology. - ## SYNTAX ``` @@ -26,10 +25,9 @@ This cmdlet enables the search topology with the given identity, marking the cur For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa -Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e @@ -38,8 +36,7 @@ Set-SPEnterpriseSearchTopology -Identity $topology -SearchApplication $ssa This example enables a search topology with the Identity 10fa59cb-4b32-4fe6-8f8d-065388df201e. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication $topology = Get-SPEnterpriseSearchTopology -SearchApplication $ssa | ?{$_.State -eq 'Inactive'} @@ -51,13 +48,15 @@ This example retreives an inactive topology and sets it to the active topology. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search topology to enable. ```yaml Type: SearchTopologyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -67,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -78,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +90,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -96,7 +100,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -SearchApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the search application to which the search topology will belong. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -113,8 +119,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPFarmConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPFarmConfig.md index ef953e645..ee4d93c4d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPFarmConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPFarmConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets a global property or a collection of global properties for the local farm. - ## SYNTAX ``` @@ -36,10 +35,9 @@ The parameter name added to the PSCustomObject object must match exactly the inp For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE-------------------------- +### EXAMPLE ```powershell Set-SPFarmConfig -WorkflowBatchSize 50 ``` @@ -49,6 +47,9 @@ This example sets the WorkflowBatdhSize to 50. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -56,8 +57,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -67,6 +67,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -74,7 +77,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -DataFormWebPartAutoRefreshEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether any DataFormWebPart on any page in this farm is allowed to periodically refresh its contents asynchronously (after the page has finished rendering). When set to false, all DataFormWebParts will ignore the automatic refresh interval provided in Web Part properties. @@ -91,8 +96,7 @@ When set to false, all DataFormWebParts will ignore the automatic refresh interv ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,13 +106,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the deletion or updating of the service connection point. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,13 +124,15 @@ Accept wildcard characters: False ``` ### -InstalledProductsRefresh + +> Applicable: SharePoint Server Subscription Edition + Updates the current machine license state with the list of products that are installed in the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +142,9 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPointBindingInformation + +> Applicable: SharePoint Server Subscription Edition + Adds or updates the service connection point for the current farm in Active Directory Domain Service (AD DS). The type must be an array of strings that are key value pairs that will be added to the service connection point. @@ -141,8 +152,7 @@ The type must be an array of strings that are key value pairs that will be added ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -152,13 +162,15 @@ Accept wildcard characters: False ``` ### -ServiceConnectionPointDelete + +> Applicable: SharePoint Server Subscription Edition + Delete the service connection point for the current farm in AD DS. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,6 +180,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -175,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -185,6 +199,9 @@ Accept wildcard characters: False ``` ### -WorkflowBatchSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the paging size for events delivered to a single workflow instance. For each request, the events are streamed out 100 at a time. @@ -195,8 +212,7 @@ Throttle will override batch size; if the workflow instance cannot be started or ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -206,6 +222,9 @@ Accept wildcard characters: False ``` ### -WorkflowEventDeliveryTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time as an integer in which a workflow job must run without the job timing out. If the workflow job does time out, it gets put back in the queue to be run again. @@ -216,8 +235,7 @@ Any workflow job that does time out is placed back in the queue to run again.The ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,13 +245,15 @@ Accept wildcard characters: False ``` ### -WorkflowPostponeThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of workflows that can be running in IIS against a content database at a time before new workflow instances get postponed into a queue. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,13 +263,15 @@ Accept wildcard characters: False ``` ### -ASPScriptOptimizationEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies if ASP Script optimization is enabled. The default value is false (off). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -259,13 +281,15 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPathIsImmutable + +> Applicable: SharePoint Server Subscription Edition + Specifies if the `UserAccountDirectoryPath` property on an `SPSite` object is immutable. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -275,13 +299,15 @@ Accept wildcard characters: False ``` ### -DefaultActivateOnSiteMasterValue + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to activate site master as default. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -291,13 +317,15 @@ Accept wildcard characters: False ``` ### -MaxSiteSubscriptionSettingsValueLength + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum size of a SiteSubscription property value. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -307,13 +335,15 @@ Accept wildcard characters: False ``` ### -MaxTenantStoreValueLength + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum size of a Tenant Store property value. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -323,13 +353,15 @@ Accept wildcard characters: False ``` ### -SiteMasterMode + +> Applicable: SharePoint Server Subscription Edition + Specifies if site master mode is turned on or off. The default value is off. ```yaml Type: SPSiteMasterMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -339,6 +371,9 @@ Accept wildcard characters: False ``` ### -SiteMasterValidationIntervalInHours + +> Applicable: SharePoint Server Subscription Edition + Determines the length of time, in hours, to validate the Site Master. The default value is 24. @@ -346,8 +381,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPIRMSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPIRMSettings.md index b4a5cf13e..1d5660b51 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPIRMSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPIRMSettings.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the Information Rights Management (IRM) settings. - ## SYNTAX ### UseSpecifiedCertificateUrl @@ -38,24 +37,23 @@ Use the `Set-SPIRMSettings` cmdlet to set the Information Rights Management (IRM For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ```powershell Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery ``` This example enables IRM for the farm and configures it to use the default RMS server configured in Active Directory. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell Set-SPIRMSettings -RmsEnabled -CertificateServerUrl https://myrmsserver ``` This example enables IRM for the farm and specifies the URL of the RMS server to use. -### --------------EXAMPLE 3------------ +### EXAMPLE 3 ```powershell site = Get-SPSite http://myspserver $subscription = $site.SiteSubscription @@ -64,24 +62,25 @@ Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServer This example enables IRM for the specified tenant and specifies the URL of the RMS server to use. -### --------------EXAMPLE 4------------ +### EXAMPLE 4 ```powershell Set-SPIRMSettings -RmsEnabled:$false ``` This example disables IRM for the farm. - ## PARAMETERS ### -CertificateServerUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the address of the RMS certificate server to use for the tenant. ```yaml Type: Uri Parameter Sets: UseSpecifiedCertificateUrl -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +90,9 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not IRM is enabled in the tenant. The default value is false. @@ -98,8 +100,7 @@ The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -109,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -120,8 +124,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,14 +134,16 @@ Accept wildcard characters: False ``` ### -CertificatePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +153,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +163,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -165,6 +172,9 @@ Accept wildcard characters: False ``` ### -ServiceAuthenticationCertificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the service authentication certificate. If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. @@ -173,8 +183,7 @@ If the parameter is not specified, the local farm connects to RMS server using i ```yaml Type: X509Certificate2 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,6 +193,9 @@ Accept wildcard characters: False ``` ### -SubscriptionScopeSettingsEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not IRM can be configured at the site subscription scope. Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope. @@ -191,8 +203,7 @@ Site subscriptions can only configure custom IRM settings if IRM is enabled at t ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,13 +213,15 @@ Accept wildcard characters: False ``` ### -UseActiveDirectoryDiscovery + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the domain. ```yaml Type: SwitchParameter Parameter Sets: UseServiceDiscovery -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -218,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -225,7 +241,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -235,6 +250,9 @@ Accept wildcard characters: False ``` ### -UseOauth + +> Applicable: SharePoint Server Subscription Edition + Specifies whether OAuth should be used. The valid values are True and False. @@ -242,8 +260,7 @@ The valid values are True and False. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormTemplate.md index b2b835902..288f9db28 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormTemplate.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a InfoPath form template. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Set-SPInfoPathFormsTemplate` cmdlet modifies the category of an InfoPath fo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Set-InfoPathFormTemplate -Identity "Sample.xsn" -Category "WorkFlowCategory" ``` This example modifies the category property of a form template for a specified name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies the category of the form template. The category name can have a maximum of 255 characters. @@ -88,8 +92,7 @@ The type must be a valid name of a form template category; for example, FormTemp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,6 +121,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormsService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormsService.md index cc5c8c6dd..8415d8e43 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormsService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathFormsService.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets parameters for InfoPath Forms Services in SharePoint Server. - ## SYNTAX ``` @@ -32,17 +31,16 @@ The `Set-SPInfoPathFormsService` cmdlet modifies the settings for InfoPath Forms For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Set-SPInfoPathFormsService -AllowUserFormBrowserEnabling $true -AllowUserFormBrowserRendering $false ``` This example modifies the AllowUserFormBrowserEnabling and AllowUserFormBrowserRendering parameter values. -### --------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Set-SPInfoPathFormsService -AllowViewState $true -ViewStateThreshold 40961 ``` @@ -52,6 +50,9 @@ This example modifies the AllowViewState and ViewStateThreshold parameter values ## PARAMETERS ### -ActiveSessionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the duration, in minutes, that a form's session state can remain active. The default value is 1440. @@ -60,8 +61,7 @@ The type must be a non-negative integer value in the range from 0 through 999,99 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -71,6 +71,9 @@ Accept wildcard characters: False ``` ### -AllowEmbeddedSqlForDataConnections + +> Applicable: SharePoint Server Subscription Edition + Specifies a value that indicates whether embedded SQL authentication can be used by browser-enabled InfoPath form templates. The type must be one of the following values: True, False (default) @@ -78,8 +81,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -89,6 +91,9 @@ Accept wildcard characters: False ``` ### -AllowUdcAuthenticationForDataConnections + +> Applicable: SharePoint Server Subscription Edition + Specifies that authentication information in a universal data connection (.udcx file) can be used. The type must be one of the following values: True (default), False @@ -96,8 +101,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +111,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormBrowserEnabling + +> Applicable: SharePoint Server Subscription Edition + Specifies that users can browser enable form templates that do not contain form code, require full trust, enable rendering on a mobile device, or use a data connection managed by a server administrator. The type must be one of the following values: True (default), False @@ -114,8 +121,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,6 +131,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormBrowserRendering + +> Applicable: SharePoint Server Subscription Edition + Specifies that browser-enabled form templates will be rendered by InfoPath Forms Services. The type must be one of the following values: True (default), False @@ -132,8 +141,7 @@ The type must be one of the following values: True (default), False ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +151,9 @@ Accept wildcard characters: False ``` ### -AllowUserFormCrossDomainDataConnections + +> Applicable: SharePoint Server Subscription Edition + Specifies that data connections to data sources located in a different domain can be queried. The type must be one of the following values: True, False (default) @@ -150,8 +161,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,6 +171,9 @@ Accept wildcard characters: False ``` ### -AllowViewState + +> Applicable: SharePoint Server Subscription Edition + Defines the location to store form session state: View state when True, or Session State Service when False. The type must be one of the following values: True, False (default) @@ -168,8 +181,7 @@ The type must be one of the following values: True, False (default) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,6 +191,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -190,8 +205,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +215,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -208,7 +225,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -218,6 +234,9 @@ Accept wildcard characters: False ``` ### -DefaultDataConnectionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the default data connection timeout in milliseconds. The default value is 10000 (10 seconds). @@ -226,8 +245,7 @@ The type must be a non-negative integer and less than or equal to the value set ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -237,6 +255,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath Forms Services service to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an InfoPath Forms Services service (for example, FormsService1); or an instance of a valid SPFormsService object. @@ -244,8 +265,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormsServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -255,6 +275,9 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionResponseSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum size allowed for a data connection response. The default value is 15000 kilobytes (KB). @@ -263,8 +286,7 @@ The type must be a non-negative integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -274,14 +296,16 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionRoundTrip + +> Applicable: SharePoint Server Subscription Edition + Sets a threshold, in milliseconds, for the maximum time it takes from the start of a data request to the return of the data request on the server (the data connection round trip). If the data connection round trip time exceeds this threshold, an event is logged in the Operational log. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -291,6 +315,9 @@ Accept wildcard characters: False ``` ### -MaxDataConnectionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum data connection timeout in milliseconds. The default value is 20000 (20 seconds). @@ -299,8 +326,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -310,6 +336,9 @@ Accept wildcard characters: False ``` ### -MaxFormLoadTime + +> Applicable: SharePoint Server Subscription Edition + Sets a threshold, in milliseconds, for maximum form load time. If form load time exceeds this threshold, an event is logged in the Operational log. @@ -318,8 +347,7 @@ The MaxFormLoadTime parameter measures the time it takes for a form to open, sta ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -329,6 +357,9 @@ Accept wildcard characters: False ``` ### -MaxPostbacksPerSession + +> Applicable: SharePoint Server Subscription Edition + Specifies the value of the maximum postbacks that an instance of a browser-enabled InfoPath form template can make to the InfoPath Forms Services service. The default value is 20. @@ -337,8 +368,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -348,6 +378,9 @@ Accept wildcard characters: False ``` ### -MaxUserActionsPerPostback + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum user actions per postback. The default value is 200. @@ -356,8 +389,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -367,6 +399,9 @@ Accept wildcard characters: False ``` ### -MemoryCacheSize + +> Applicable: SharePoint Server Subscription Edition + Sets the size, in megabytes (MB), of the cache for solutions in memory. The default value is 250 MB. @@ -374,8 +409,7 @@ The default value is 250 MB. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -385,6 +419,9 @@ Accept wildcard characters: False ``` ### -RequireSslForDataConnections + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Sockets Layer (SSL) requirement value. If data connections in browser-enabled form templates require basic authentication or digest authentication, a password is sent over the network. Set this value to True to require an SSL-encrypted connection for these authentication types. @@ -394,8 +431,7 @@ The type must be one of the following values: True (default), False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -405,6 +441,9 @@ Accept wildcard characters: False ``` ### -ViewStateThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum size in kilobytes of the session state when stored in the form view. The default value is 40. @@ -413,8 +452,7 @@ The type must be a non-negative integer and less than or equal to 99,999,999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -424,6 +462,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -431,7 +472,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -441,6 +481,9 @@ Accept wildcard characters: False ``` ### -MaxSizeOfUserFormState + +> Applicable: SharePoint Server Subscription Edition + Specifies the value of the maximum size in kilobytes of session state an instance of a browser-enabled InfoPath form template can use. The default value is 4096. The type must be a non-negative integer and less than or equal to 999999. @@ -448,8 +491,7 @@ The type must be a non-negative integer and less than or equal to 999999. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathWebServiceProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathWebServiceProxy.md index d352872dc..030418141 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathWebServiceProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInfoPathWebServiceProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets parameters for an existing SharePoint Web service application. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Set-SPInfoPathWebServiceProxy` cmdlet configures exposed parameters for an For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Set-SPInfoPathWebServiceProxy -Identity "https://server_name" -AllowWebServiceProxy $true ``` This example sets the Web service proxy for a Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web service application proxy to update. The type must be a valid URL, in the form https://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. @@ -47,8 +47,7 @@ The type must be a valid URL, in the form https://server_name; a valid name of a ```yaml Type: SPWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AllowForUserForms + +> Applicable: SharePoint Server Subscription Edition + Specifies that a form opened in the InfoPath client can use the InfoPath Forms Services Web service proxy to connect to a Web service. This parameter can be set only when AllowWebServiceProxy is set to True. @@ -66,8 +68,7 @@ The type must be one of the following: True, False The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AllowWebServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies that browser-enabled form templates can use the InfoPath Forms Services Web service proxy to connect to a Web service. The type must be one of the following: True, False The default value is False. @@ -84,8 +88,7 @@ The type must be one of the following: True, False The default value is False. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -106,8 +112,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -141,7 +151,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInternalAppStateUpdateInterval.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInternalAppStateUpdateInterval.md index 6c80f4539..038d1885e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInternalAppStateUpdateInterval.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPInternalAppStateUpdateInterval.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the interval in hours between updates of the internal app state update job. - ## SYNTAX ``` @@ -26,27 +25,27 @@ The internal app state update job gets app upgrades from the internal app direct For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------------ +### EXAMPLE ```powershell Set-SPInternalAppStateUpdateInterval -AppStateSyncHours 24 ``` This example sets a 24-hour interval between updates of the internal app state update job. - ## PARAMETERS ### -AppStateSyncHours + +> Applicable: SharePoint Server Subscription Edition + Specifies the hour for which the internal app states are updated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPLogLevel.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPLogLevel.md index a4cb44c3a..293f2caad 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPLogLevel.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPLogLevel.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the trace and event level for a set of categories. - ## SYNTAX ``` @@ -27,44 +26,42 @@ If an event or trace associated with a category occurs and is equally severe or For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell set-sploglevel -TraceSeverity Monitorable ``` This example sets the TraceSeverity values for all categories to Monitorable. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Set-SPLogLevel -TraceSeverity High -EventSeverity Warning -Identity "Cat1" ``` This example sets the EventSeverity and TraceSeverity values for a single category. - -### ------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell "Cat1", "Cat2", "Cat3" | Set-SPLogLevel -EventSeverity Error ``` This example sets the EventSeverity values for multiple categories. - -### ------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ```powershell Set-SPLogLevel -EventSeverity Warning -Identity "AreaName:*" ``` This example sets the EventSeverity values for all categories in the same area. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -87,6 +83,9 @@ Accept wildcard characters: False ``` ### -EventSeverity + +> Applicable: SharePoint Server Subscription Edition + Specifies the category level to be set. The category level is any one of the following values: @@ -100,8 +99,7 @@ The category level is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,14 +109,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event-throttling setting is applied to all categories in the farm. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,14 +128,16 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: SharePoint Server Subscription Edition + The InputObject is pipelined to the cmdlet and can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the `Get-SPLogLevel` cmdlet, modify the category values and then pipeline them into the `Set-SPLogLevel` cmdlet. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +147,9 @@ Accept wildcard characters: False ``` ### -TraceSeverity + +> Applicable: SharePoint Server Subscription Edition + Specifies trace throttle to set the specified categor(ies) to. The trace log files are text files that are written to the trace log path that is defined on the Diagnostic Logging Settings page on the SharePoint Central Administration site. The type must be any one of the following values: @@ -160,8 +165,7 @@ The type must be any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMachineKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMachineKey.md index c3785b139..a9e6289d9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMachineKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMachineKey.md @@ -24,7 +24,7 @@ The \`Set-SPMachineKey\` cmdlet configures the ASP.NET view state decryption and ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Set-SPMachineKey -WebApplication http://sitename ``` @@ -32,7 +32,7 @@ Set-SPMachineKey -WebApplication http://sitename This example sets the ASP.NET view state decryption and validation keys for web application 'http://sitename' to new randomly generated keys. The new keys are deployed to all servers in the farm. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Set-SPMachineKey -WebApplication http://sitename -DecryptionKey '' -ValidationKey '' -Local ``` @@ -44,6 +44,9 @@ See **How to generate a ` element`** in the [Resolving view state me ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -56,7 +59,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -66,6 +68,9 @@ Accept wildcard characters: False ``` ### -DecryptionKey + +> Applicable: SharePoint Server Subscription Edition + Specifies the new ASP.NET view state decryption key. The key should be represented as a 64-character long hexadecimal string (0-9 and A-F). @@ -75,7 +80,6 @@ If this parameter is not specified, a random decryption key will be generated an Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Deploy the new decryption and validation keys only to the local server. Other servers in the farm will continue to use the previous decryption and validation keys. Web sessions that are load balanced across multiple servers in the farm will fail if these keys are not synchronized on every server in the farm. @@ -96,7 +103,6 @@ If this parameter is not specified, the new decryption and validation keys will Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -106,6 +112,9 @@ Accept wildcard characters: False ``` ### -ValidationKey + +> Applicable: SharePoint Server Subscription Edition + Specifies the new ASP.NET view state validation key. The key should be represented as a 64-character long hexadecimal string (0-9 and A-F). @@ -115,7 +124,6 @@ If this parameter is not specified, a random decryption key will be generated an Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,13 +133,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -141,13 +151,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -157,6 +169,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -164,7 +179,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPManagedAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPManagedAccount.md index a45facc00..44211e9e6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPManagedAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPManagedAccount.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the managed account. - ## SYNTAX ### NewPassword @@ -60,7 +59,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $m = Get-SPManagedAccount -Identity "DOMAINx\UserY" Set-SPManagedAccount -Identity $m -AutoGeneratePassword true @@ -68,10 +67,12 @@ Set-SPManagedAccount -Identity $m -AutoGeneratePassword true This example displays an explicit managed account if it exists and then attempts to update it to use automatically generated passwords. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the full name or partial name of the managed accounts to retrieve. The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876. @@ -79,8 +80,7 @@ The type must be a valid account name, in the form Domain\User, or a GUID, in th ```yaml Type: SPManagedAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -90,13 +90,15 @@ Accept wildcard characters: False ``` ### -ConfirmPassword + +> Applicable: SharePoint Server Subscription Edition + Confirms the new password for this managed account. ```yaml Type: SecureString Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,13 +108,15 @@ Accept wildcard characters: False ``` ### -ExistingPassword + +> Applicable: SharePoint Server Subscription Edition + Sets the password for this managed account to an existing value that has already been changed in Active Directory Domain Services (AD DS). ```yaml Type: SecureString Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -122,13 +126,15 @@ Accept wildcard characters: False ``` ### -NewPassword + +> Applicable: SharePoint Server Subscription Edition + Sets a new password for the managed account ```yaml Type: SecureString Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,13 +144,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server Subscription Edition + Sets a password for the managed account. ```yaml Type: SecureString Parameter Sets: NewPasswordAsParameter -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -154,6 +162,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -165,8 +176,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,6 +186,9 @@ Accept wildcard characters: False ``` ### -AutoGeneratePassword + +> Applicable: SharePoint Server Subscription Edition + Automatically generates a new password. The type must be either of the following values: @@ -188,8 +201,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: AutoGeneratePassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,6 +211,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -206,7 +221,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -216,6 +230,9 @@ Accept wildcard characters: False ``` ### -EmailNotification + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days before password change to begin e-mail notifications. The default value is 5. @@ -223,8 +240,7 @@ The default value is 5. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -234,6 +250,9 @@ Accept wildcard characters: False ``` ### -PreExpireDays + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days before expiration to schedule password change. The default value is 2. @@ -241,8 +260,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -252,13 +270,15 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server Subscription Edition + Specifies the new schedule on which the password change job is to run. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -268,6 +288,9 @@ Accept wildcard characters: False ``` ### -SetNewPassword + +> Applicable: SharePoint Server Subscription Edition + Sets the password to the new value that is passed in, and changes the value in AD DS. The type must be either of the following values: @@ -280,8 +303,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: NewPassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -291,6 +313,9 @@ Accept wildcard characters: False ``` ### -UseExistingPassword + +> Applicable: SharePoint Server Subscription Edition + Sets the password to a new value passed in where the value is already changed in AD DS. The type must be either of the following values: @@ -303,8 +328,7 @@ The default value is False. ```yaml Type: SwitchParameter Parameter Sets: ExistingPassword -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -314,6 +338,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -321,7 +348,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplication.md index 6f6145282..1db88eaee 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a managed metadata service application. - ## SYNTAX ### NoQuota @@ -43,10 +42,9 @@ Use the `Set-SPMetadataServiceApplication` cmdlet to set the properties of a man For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell $sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' Set-SPMetadataServiceApplication -Identity $sa -HubUri 'https://sitename' -SyndicationErrorReportEnabled @@ -55,8 +53,7 @@ Set-SPMetadataServiceApplication -Identity $sa -HubUri 'https://sitename' -Syndi This example adds a content type hub to an existing managed metadata service application. It also enables error reporting when content types are imported. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell $sa = Get-SPMetadataServiceApplication -Identity 'Managed Metadata Service Application' Set-SPMetadataServiceApplication -Identity $sa -AdministratorAccount 'contoso\username1' -FullAccessAccount 'contoso\AppPoolAccount1,contoso\AppPoolAccount2' -RestrictedAccount 'contoso\AppPoolAccount3,contoso\AppPoolAccount4,contoso\AppPoolAccount5' -ReadAccessAccount 'contoso\AppPoolAccount6' @@ -67,10 +64,12 @@ This example sets permissions on an existing managed metadata service applicatio If you use Windows PowerShell to set any of the account values, you should set all of them. The `Set-SPMetadataServiceApplication` cmdlet first erases all accounts, then adds the accounts that you specified. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed metadata service application to update. The type must be a valid GUID or the name of a valid managed metadata service application. @@ -78,8 +77,7 @@ The type must be a valid GUID or the name of a valid managed metadata service a ```yaml Type: SPMetadataServiceCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -89,6 +87,9 @@ Accept wildcard characters: False ``` ### -AdministratorAccount + +> Applicable: SharePoint Server Subscription Edition + A comma-separated list of user accounts or service accounts in the format \\\\ that may create and run the service application. The accounts must already exist. @@ -98,8 +99,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +109,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies an existing IIS application pool in which to run the Web service for the managed metadata service application. The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool; or an instance of a valid SPServiceApplicationPool object. @@ -116,8 +119,7 @@ The value must be a GUID that is the identity of an SPServiceApplicationPool obj ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,6 +129,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -138,8 +143,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -149,6 +153,9 @@ Accept wildcard characters: False ``` ### -CacheTimeCheckInterval + +> Applicable: SharePoint Server Subscription Edition + Specifies the interval, in seconds, that a front-end Web server should wait before asking the application server for changes. This value is set per timer job, client application, or Web application. @@ -158,8 +165,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +175,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -186,6 +194,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If SQL authentication is to be used, either the DatabaseCredentials parameter must be specified or both the DatabaseUserName and DatabasePassword parameters must be set. @@ -195,8 +206,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -206,6 +216,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database that contains the term store for the managed metadata service application. The type must be a valid name of a SQL Server database; for example MeatadataDB1. @@ -213,8 +226,7 @@ The type must be a valid name of a SQL Server database; for example MeatadataDB1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -224,6 +236,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid name of a SQL Server database; for example SqlServerHost1. @@ -231,8 +246,7 @@ The type must be a valid name of a SQL Server database; for example SqlServerHos ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -242,6 +256,9 @@ Accept wildcard characters: False ``` ### -DoNotUnpublishAllPackages + +> Applicable: SharePoint Server Subscription Edition + If this flag is set, the packages will not be unpublished. If the HubUri parameter is changed, all content type packages will be unpublished by default. @@ -250,8 +267,7 @@ If the HubUri parameter is not changed, this flag has no effect. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -261,6 +277,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -268,8 +287,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -279,6 +297,9 @@ Accept wildcard characters: False ``` ### -FullAccessAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read/write permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -288,8 +309,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -299,14 +319,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new name of the service application. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -316,6 +338,9 @@ Accept wildcard characters: False ``` ### -RestrictedAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given permission to read the managed metadata service's term store and content type gallery and permission to write to open term sets and local term sets and to create new enterprise keywords. The accounts must already exist. @@ -325,8 +350,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -336,13 +360,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables reporting of errors when content types are imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -352,13 +378,15 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -368,6 +396,9 @@ Accept wildcard characters: False ``` ### -MaxChannelCache + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server holds open to the application server. This value is set per timer job, client application, or Web application. @@ -377,8 +408,7 @@ The default value is 4. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -388,6 +418,9 @@ Accept wildcard characters: False ``` ### -ReadAccessAccount + +> Applicable: SharePoint Server Subscription Edition + Specifies a comma-separated set of application pool accounts in the format \\\\ that will be given read-only permission to the managed metadata service's term store and content type gallery. The accounts must already exist. @@ -397,8 +430,7 @@ Consider setting all four parameters at the same time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -408,6 +440,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -415,7 +450,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -425,13 +459,15 @@ Accept wildcard characters: False ``` ### -DisablePartitionQuota + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, disables the partition quota. ```yaml Type: SwitchParameter Parameter Sets: NoQuota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -441,13 +477,15 @@ Accept wildcard characters: False ``` ### -GroupsPerPartition + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, sets the maximum number of groups per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -457,13 +495,15 @@ Accept wildcard characters: False ``` ### -LabelsPerPartition + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, sets the maximum number of labels per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -473,13 +513,15 @@ Accept wildcard characters: False ``` ### -PropertiesPerPartition + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, sets the maximum number of properties per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -489,13 +531,15 @@ Accept wildcard characters: False ``` ### -TermSetsPerPartition + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, sets the maximum number of term sets per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -505,13 +549,15 @@ Accept wildcard characters: False ``` ### -TermsPerPartition + +> Applicable: SharePoint Server Subscription Edition + When in partitioned mode, sets the maximum number of terms per partition. ```yaml Type: Int32 Parameter Sets: Quota -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplicationProxy.md index a1352b45c..e67472c8d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMetadataServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of a connection to a managed metadata service application. - ## SYNTAX ``` @@ -27,36 +26,35 @@ Use the `Set-SPMetadataServiceApplicationProxy` cmdlet to set the properties of For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled -ContentTypePushdownEnabled ``` This example enables content type syndication and enables content type pushdown on an existing connection to a managed metadata service application. - -### -----------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -ContentTypeSyndicationEnabled:$false -ContentTypePushdownEnabled:$false ``` This example disables content type syndication and disables content type pushdown on an existing connection to a managed metadata service application. - -### -----------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell Set-SPMetadataServiceApplicationProxy -Identity "MetadataServiceProxy1" -DefaultKeywordTaxonomy -DefaultSiteCollectionTaxonomy:$false ``` This example configures an existing connection to a managed metadata service application to be the default location for storing enterprise keywords and prevents it from being the default location for storing column-specific term sets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection to update. The type must be a GUID that represents the identity of the connection to modify, the name of a valid connection to a managed metadata service, or an instance of a valid SPMetadataServiceProxy object. @@ -64,8 +62,7 @@ The type must be a GUID that represents the identity of the connection to modify ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -75,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +86,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +106,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,13 +115,15 @@ Accept wildcard characters: False ``` ### -ContentTypePushdownEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that existing instances of changed content types in subsites and libraries will be updated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +133,15 @@ Accept wildcard characters: False ``` ### -ContentTypeSyndicationEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that this connection will provide access to the content types that are associated with the managed metadata service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +151,9 @@ Accept wildcard characters: False ``` ### -DefaultKeywordTaxonomy + +> Applicable: SharePoint Server Subscription Edition + Specifies that new enterprise keywords will be stored in the term store associated with the managed metadata service application. Do not make more than one connection the default keyword location. @@ -153,8 +161,7 @@ Do not make more than one connection the default keyword location. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,6 +171,9 @@ Accept wildcard characters: False ``` ### -DefaultSiteCollectionTaxonomy + +> Applicable: SharePoint Server Subscription Edition + Specifies that the term set that is created when you create a new managed metadata column will be stored in the term store associated with the managed metadata service application. Do not make more than one connection the default location for site collection term sets. @@ -171,8 +181,7 @@ Do not make more than one connection the default location for site collection te ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,14 +191,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the new display name of the connection. The name can contain a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -199,13 +210,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the connection be added to the default proxy group of the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -215,6 +228,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -222,7 +238,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMicrofeedOptions.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMicrofeedOptions.md index 3efd0914b..1df105773 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMicrofeedOptions.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMicrofeedOptions.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spmicrofeedoptions -Applicable: SharePoint Server Subscription Edition + title: Set-SPMicrofeedOptions schema: 2.0.0 --- @@ -10,8 +10,7 @@ schema: 2.0.0 # Set-SPMicrofeedOptions ## SYNOPSIS -Sets the feed cache settings. - +Sets the feed cache settings. ## SYNTAX @@ -25,10 +24,9 @@ Set-SPMicrofeedOptions [-AssignmentCollection ] [-AsyncR ## DESCRIPTION Use the Set-SPMicrofeedOptions cmdlet to set the feed cache settings for the current user profile application. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -MaxTags 4 @@ -36,18 +34,19 @@ Set-SPMicrofeedOptions -ProfileServiceApplicationProxy $proxy -MaxTags 4 This example sets the maximum tags per post and reply to 4 for the specified User Profile Service Application Proxy. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,15 +56,16 @@ Accept wildcard characters: False ``` ### -AsyncRefs -Performs reference-posts via async threads. If the value is set to True, each @mention in a thread is handled in its own .NET threadpool async thread. +> Applicable: SharePoint Server Subscription Edition + +Performs reference-posts via async threads. If the value is set to True, each @mention in a thread is handled in its own .NET threadpool async thread. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,13 +75,15 @@ Accept wildcard characters: False ``` ### -MaxCacheMs + +> Applicable: SharePoint Server Subscription Edition + Specifies the permissible range of cache loop up time. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,13 +93,15 @@ Accept wildcard characters: False ``` ### -MaxMentions + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number @mentions per post and reply. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,13 +111,15 @@ Accept wildcard characters: False ``` ### -MaxPostLength + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum number of characters in a Microfeed post. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,13 +129,15 @@ Accept wildcard characters: False ``` ### -MaxTags + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number #tags per post and reply. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,13 +147,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -155,13 +165,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMobileMessagingAccount.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMobileMessagingAccount.md index 317743c30..a046d88e5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMobileMessagingAccount.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPMobileMessagingAccount.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the specified mobile messaging account. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Set-SPMobileMessagingAccount` cmdlet configures the specified mobile messag For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPMobileMessagingAccount -WebApplication https://sitename -Identity SMS -ServiceName SMSLink -ServiceUrl https://www.adatum.com/Service/MessagingService.asmx-UserId someone@example.com -Password password1 ``` This example changes the SMS mobile account settings of the Web application, https://sitename, to the following values:service name: SMSLink; service URL: https://www.adatum.com/Service/MessagingService.asmx; user ID: someone@example.com; and password: password1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are SMS and MMS. If you do not specify this parameter account, information is returned for both SMS and MMS. @@ -48,7 +48,6 @@ If you do not specify this parameter account, information is returned for both S Type: SPMobileMessagingAccountPipeBind Parameter Sets: (All) Aliases: ServiceType, AccountType -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web application that hosts the managed path to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423). @@ -66,8 +68,7 @@ You either must specify WebApplication or must use the HostHeader switch and spe ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: SharePoint Server Subscription Edition + Specifies the password, if credentials are required for the account. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the SMS service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,13 +138,15 @@ Accept wildcard characters: False ``` ### -ServiceUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the SMS service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -UserId + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name, if credentials are required for the account. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPO365LinkSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPO365LinkSettings.md index 8e4cbb0d5..4412c4a58 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPO365LinkSettings.md @@ -23,11 +23,11 @@ Set-SPO365LinkSettings -MySiteHostUrl [-Audiences ] [-Redirec ## DESCRIPTION Use the **Set-SPO365LinkSettings** cmdlet to configure some of Hybrid features (Hybrid site redirection, OneDrive redirection, ODB default to Cloud) without running Hybrid Configuration Wizard. -To run this cmdlet requires farm administrator permission and that the user account has full control access to the User Profile Application service. +To run this cmdlet requires farm administrator permission and that the user account has full control access to the User Profile Application service. ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Set-SPO365LinkSettings -MySiteHostUrl https://contoso-my.sharepoint.com/ -RedirectSites $true ``` @@ -37,13 +37,16 @@ This example sets the mysite host URL to contoso-my.sharepoint.com ## PARAMETERS ### -Audiences + +> Applicable: SharePoint Server Subscription Edition + Sets the user(s) for whom redirection is active. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -52,13 +55,16 @@ Accept wildcard characters: False ``` ### -HybridAppLauncherEnabled + +> Applicable: SharePoint Server Subscription Edition + Sets a flag that indicates whether app launcher get data from SharePoint Online (SPO) is allowed ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -67,13 +73,16 @@ Accept wildcard characters: False ``` ### -MySiteHostUrl + +> Applicable: SharePoint Server Subscription Edition + Sets the root URL for the redirected pages. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: True Position: Named Default value: None @@ -82,13 +91,16 @@ Accept wildcard characters: False ``` ### -OnedriveDefaultToCloudEnabled + +> Applicable: SharePoint Server Subscription Edition + Sets a flag that indicates whether Local Onedrive is redirected to SPO OneDrive. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Required: False Position: Named Default value: None @@ -97,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -108,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,7 +137,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSetting.md index f76cd2504..45f12cddb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSetting.md @@ -35,7 +35,7 @@ Set-SPODataConnectionSetting -ServiceContext [-Servic ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell {{ Add example code here }} ``` @@ -45,6 +45,9 @@ Set-SPODataConnectionSetting -ServiceContext [-Servic ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,7 +60,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,13 +69,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMode + +> Applicable: SharePoint Server Subscription Edition + {{ Fill AuthenticationMode Description }} ```yaml Type: ODataAuthenticationMode Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Accepted values: PassThrough, RevertToSelf, Credentials, WindowsCredentials, DigestCredentials, ClientCertificate, Anonymous Required: False @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -ExtensionProvider + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ExtensionProvider Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Identity Description }} ```yaml Type: ODataConnectionSettings Parameter Sets: Identity Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 0 @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Name Description }} ```yaml Type: String Parameter Sets: Name Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -SecureStoreTargetApplicationId + +> Applicable: SharePoint Server Subscription Edition + {{ Fill SecureStoreTargetApplicationId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,13 +161,15 @@ Accept wildcard characters: False ``` ### -ServiceAddressURL + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceAddressURL Description }} ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -164,13 +179,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceContext Description }} ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -180,13 +197,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -196,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -203,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSettingMetadata.md index 07c99653a..d5bb39845 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSettingMetadata.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPODataConnectionSettingMetadata.md @@ -35,7 +35,7 @@ Set-SPODataConnectionSettingMetadata -ServiceContext ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell {{ Add example code here }} ``` @@ -45,6 +45,9 @@ Set-SPODataConnectionSettingMetadata -ServiceContext ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -57,7 +60,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,13 +69,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMode + +> Applicable: SharePoint Server Subscription Edition + {{ Fill AuthenticationMode Description }} ```yaml Type: ODataAuthenticationMode Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition + Accepted values: PassThrough, RevertToSelf, Credentials, WindowsCredentials, DigestCredentials, ClientCertificate, Anonymous Required: False @@ -84,13 +89,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Identity Description }} ```yaml Type: ODataConnectionSettings Parameter Sets: Identity Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 0 @@ -100,13 +107,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Name Description }} ```yaml Type: String Parameter Sets: Name Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -SecureStoreTargetApplicationId + +> Applicable: SharePoint Server Subscription Edition + {{ Fill SecureStoreTargetApplicationId Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -132,13 +143,15 @@ Accept wildcard characters: False ``` ### -ServiceAddressMetadataURL + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceAddressMetadataURL Description }} ```yaml Type: Uri Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,13 +161,15 @@ Accept wildcard characters: False ``` ### -ServiceContext + +> Applicable: SharePoint Server Subscription Edition + {{ Fill ServiceContext Description }} ```yaml Type: SPServiceContextPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -164,13 +179,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -180,6 +197,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -187,7 +207,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPOfficeStoreAppsDefaultActivation.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPOfficeStoreAppsDefaultActivation.md index 38117db44..3803df7f1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPOfficeStoreAppsDefaultActivation.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPOfficeStoreAppsDefaultActivation.md @@ -2,7 +2,7 @@ external help file: sharepointserver.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spofficestoreappsdefaultactivation -Applicable: SharePoint Server Subscription Edition + title: Set-SPOfficeStoreAppsDefaultActivation schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties of apps for Office. - ## SYNTAX ### AppsForOfficeSettingsInSiteSubscription @@ -36,27 +35,27 @@ Use the `Set-SPOfficeStoreAppsDefaultActivation` cmdlet to set app settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831 (https://go.microsoft.com/fwlink/p/?LinkId=251831). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPOfficeStoreAppsDefaultActivation -SiteSubscription efca5b88-b3a3-448d-afbc-ef620f4744f1 -Enable $true ``` This example enables the apps for Office from the Office Store Office client that uses the subscription id, efca5b88-b3a3-448d-afbc-ef620f4744f1. - ## PARAMETERS ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the apps for Office from the Office Store should be started. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -66,13 +65,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the Site Group to which the settings apply. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: AppsForOfficeSettingsInSiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL, GUID, or name of the web application to which the setting applies. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: AppsForOfficeSettingsInWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -109,8 +115,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -144,7 +154,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPassPhrase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPassPhrase.md index 75e3c36c0..f4c78efb9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPassPhrase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPassPhrase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the pass phrase to a new value. - ## SYNTAX ### LocalOnly @@ -40,10 +39,9 @@ So if the Passphrase fails to propagate to all servers, the LocalServerOnly para For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell $passphrase = ConvertTo-SecureString -asPlainText -Force Set-SPPassPhrase -PassPhrase $passphrase -Confirm @@ -51,10 +49,12 @@ Set-SPPassPhrase -PassPhrase $passphrase -Confirm This example queries for a string to use as a passphrase and sets the farm passphrase to a new value. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +66,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +76,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +86,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,14 +95,16 @@ Accept wildcard characters: False ``` ### -LocalServerOnly + +> Applicable: SharePoint Server Subscription Edition + Scopes the Passphrase change to the local server only. If this parameter is not used, the Passphrase change is performed farm-wide. ```yaml Type: SwitchParameter Parameter Sets: LocalOnly -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -118,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,13 +133,15 @@ Accept wildcard characters: False ``` ### -ConfirmPassPhrase + +> Applicable: SharePoint Server Subscription Edition + Passphrase is typed a second time to confirm that it matches the first entry. ```yaml Type: SecureString Parameter Sets: AcrossFarm -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -144,13 +151,15 @@ Accept wildcard characters: False ``` ### -PassPhrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the new Passphrase value. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPeoplePickerConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPeoplePickerConfig.md index 62bcfe20f..59824698b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPeoplePickerConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPeoplePickerConfig.md @@ -35,7 +35,7 @@ This Set-SPPeoplePickerConfig cmdlet sets the following settings of People Picke ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Set-SPPeoplePickerConfig -WebApplication http://MyOfficeApp1 -ActiveDirectoryCustomFilter "((Title=Manager))" -ActiveDirectoryCustomQuery (sn={0}*) -ActiveDirectorySearchTimeout 60 -PeopleEditorOnlyResolveWithinSiteCollection -OnlySearchWithinSiteCollection -NoWindowsAccountsForNonWindowsAuthenticationMode ``` @@ -51,13 +51,15 @@ This example sets the following settings to the People Picker of Web application ## PARAMETERS ### -ActiveDirectoryCustomFilter + +> Applicable: SharePoint Server Subscription Edition + The Lightweight Directory Access Protocol (LDAP) query string to create a customized filter for displaying query results. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectoryCustomQuery + +> Applicable: SharePoint Server Subscription Edition + The Lightweight Directory Access Protocol (LDAP) query string appended to the People Picker query to Active Directory. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -ActiveDirectorySearchTimeout + +> Applicable: SharePoint Server Subscription Edition + The amount of seconds of time before Active Directory search times out. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,7 +120,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -121,13 +129,15 @@ Accept wildcard characters: False ``` ### -NoWindowsAccountsForNonWindowsAuthenticationMode + +> Applicable: SharePoint Server Subscription Edition + Specifies the People Picker control return only non-Active Directory users when the Web application uses form-based authentication. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,13 +147,15 @@ Accept wildcard characters: False ``` ### -OnlySearchWithinSiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies the People Picker control should only return the site collection users when using the "Select People and Groups" dialog box. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -153,13 +165,15 @@ Accept wildcard characters: False ``` ### -PeopleEditorOnlyResolveWithinSiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies the People Picker control should only return the site collection users when click the "Check Names" button. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -169,13 +183,15 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to enable Secure LDAP (LDAPS) for secure communication in the SharePoint People Picker. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -185,13 +201,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + The Web application to set People Picker settings to. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -201,13 +219,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -217,6 +237,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -224,7 +247,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPowerPointConversionServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPowerPointConversionServiceApplication.md index 24d50b8a1..dc66f4d1e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPowerPointConversionServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPPowerPointConversionServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures settings for a PowerPoint Conversion Service application. - ## SYNTAX ``` @@ -25,35 +24,34 @@ Set-SPPowerPointConversionServiceApplication [-Identity] Applicable: SharePoint Server Subscription Edition + Specifies the unique name of this PowerPoint Conversion Service application. ```yaml Type: SPPowerPointConversionServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,14 +85,16 @@ Accept wildcard characters: False ``` ### -CacheExpirationPeriodInSeconds + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum time, in seconds, that items remain in the back-end server cache. The default value is 600 seconds (10 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,14 +104,16 @@ Accept wildcard characters: False ``` ### -MaximumConversionsPerWorker + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of presentations that a conversion worker process can convert before recycling. The default value is 5. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,14 +123,16 @@ Accept wildcard characters: False ``` ### -WorkerKeepAliveTimeoutInSeconds + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum time, in seconds, that a conversion worker process can be unresponsive before being terminated. The default value is 120 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +142,9 @@ Accept wildcard characters: False ``` ### -WorkerProcessCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of active instances of the conversion worker process on each back-end. This value must be less than the Windows Communication Foundation (WCF) connection limit for this computer. The default value is 3. @@ -143,8 +152,7 @@ The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,14 +162,16 @@ Accept wildcard characters: False ``` ### -WorkerTimeoutInSeconds + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum time, in seconds, that a conversion worker process is given for any single conversion. The default is 300 seconds (5 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplication.md index e2ad73612..7da1e163f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplication.md @@ -48,10 +48,9 @@ The Set-SPProfileServiceApplication cmdlet sets properties of a User Profile Ser For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------EXAMPLE--------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true @@ -59,10 +58,12 @@ Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true This example purges objects from the Profile database which are not in scope of the User Profile import. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -70,8 +71,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -81,6 +81,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool in which to run the Web service for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -88,8 +91,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -110,8 +115,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -121,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,14 +144,16 @@ Accept wildcard characters: False ``` ### -GetNonImportedObjects + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to inform the users that did not come from the import pipeline and will be marked for deletion. The list of users marked for deletion is displayed to the console window. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,15 +163,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the My Site will be provisioned. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -172,20 +182,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +### -MySiteManagedPath -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -MySiteManagedPath Specifies the managed path location of personal sites. The type must be a valid URL, in the form https://server_name. @@ -193,8 +193,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,6 +203,9 @@ Accept wildcard characters: False ``` ### -ProfileDBCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates. The type must be a valid PSCredential object. @@ -211,8 +213,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -222,6 +223,9 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter. The type must be a valid PSCredential object. @@ -229,8 +233,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -240,14 +243,16 @@ Accept wildcard characters: False ``` ### -ProfileSyncDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -257,14 +262,16 @@ Accept wildcard characters: False ``` ### -PurgeNonImportedObjects + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to mark the non-imported users in the profile store for deletion and then inform the users that did not come from the import pipeline which will be marked for deletion. The list of users marked for deletion is displayed on the console window ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -274,6 +281,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -292,8 +302,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -303,6 +312,9 @@ Accept wildcard characters: False ``` ### -SocialDBCredentials + +> Applicable: SharePoint Server Subscription Edition + The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates. The type must be a valid PSCredential object. @@ -310,8 +322,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -321,14 +332,16 @@ Accept wildcard characters: False ``` ### -SocialDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the failover SQL server for Social database. It is used to build the connection string for the Social database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -338,6 +351,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name for the new User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -347,8 +363,7 @@ The type must be a valid name of a User Profile Service application; for example ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -358,6 +373,9 @@ Accept wildcard characters: False ``` ### -UseOnlyPreferredDomainControllers + +> Applicable: SharePoint Server Subscription Edition + Restricts profile synchronization communication to a specific domain controller. The valid values are $true or $false. @@ -365,8 +383,7 @@ The valid values are $true or $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -376,6 +393,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -383,7 +403,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -393,13 +412,15 @@ Accept wildcard characters: False ``` ### -ProfileDBFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationProxy.md index 23480c43c..48a4af8a7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationProxy.md @@ -26,10 +26,9 @@ The `Set-SPProfileServiceApplicationProxy` cmdlet sets properties of a proxy for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ----------------EXAMPLE--------------------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName -eq 'User Profile Service Application Proxy'} Set-SPProfileServiceApplicationProxy -Identity $proxy -SiteNamingConflictResolution 2 @@ -37,20 +36,20 @@ Set-SPProfileServiceApplicationProxy -Identity $proxy -SiteNamingConflictResolut This example sets the User Profile Service Application Proxy to use a site naming conflict resolution to use domain names prefixed to usernames. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. - ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -89,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the User Profile Service application proxy is added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the My Site will be created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -122,8 +130,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,6 +140,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed path location of personal sites. The type must be a valid URL, in the form https://server_name. @@ -140,8 +150,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +160,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name for the User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. @@ -160,8 +172,7 @@ The type must be a name of a valid service application proxy; for example, UserP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,6 +182,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -189,8 +203,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -200,6 +213,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -207,7 +223,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationSecurity.md index 0398bde9c..6c266a94a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProfileServiceApplicationSecurity.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} $security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy @@ -44,7 +44,7 @@ Set-SPProfileServiceApplicationSecurity -Identity $security -ProfileServiceAppli This example revokes the right 'Create Personal Site' from All Authenticated Users. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} $security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy @@ -58,13 +58,15 @@ This example grants the right 'All' to All Authenticated Users. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service Application security object. ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ``` ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the unique identifier for the proxy. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -97,8 +104,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +114,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -115,7 +124,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,14 +133,16 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +152,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of object to display. The type is any one of the following values: @@ -152,8 +165,7 @@ The type is any one of the following values: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -170,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectDatabaseQuota.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectDatabaseQuota.md index 19746bf5b..5b33240c1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectDatabaseQuota.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectDatabaseQuota.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectdatabasequota -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectDatabaseQuota schema: 2.0.0 --- @@ -32,27 +32,27 @@ Microsoft internal use only. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell {{ Add example code here }} ``` {{ Add example description here }} - ## PARAMETERS ### -Settings + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: ProjectDatabaseQuotaSettings Parameter Sets: settings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -62,13 +62,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: SwitchParameter Parameter Sets: options -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -78,13 +80,15 @@ Accept wildcard characters: False ``` ### -MaxDbSize + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,13 +98,15 @@ Accept wildcard characters: False ``` ### -ReadOnlyLimit + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -110,13 +116,15 @@ Accept wildcard characters: False ``` ### -ReadOnlyWarningThreshold + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: options -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -126,13 +134,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -142,13 +152,15 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Microsoft internal use only. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectEventServiceSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectEventServiceSettings.md index 5e38040a9..950de4393 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectEventServiceSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectEventServiceSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojecteventservicesettings -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectEventServiceSettings schema: 2.0.0 --- @@ -24,17 +24,19 @@ Allows you to change the Microsoft Project Server Events Service 2016 TCP port s ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPProjectEventServiceSettings -NetTcpPort 16100 ``` This example tells the service to listen on port 16100. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -42,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -53,13 +54,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: SharePoint Server Subscription Edition + TCP port to listen on. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectOdataConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectOdataConfiguration.md index 3380749b4..12fad17a6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectOdataConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectOdataConfiguration.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectodataconfiguration -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectOdataConfiguration schema: 2.0.0 --- @@ -25,56 +25,53 @@ Set-SPProjectOdataConfiguration [-AcceptCountRequests ] [-AcceptProject The `Set-SPProjectOdataConfiguration` cmdlet sets the settings for how the OData service is configured for an instance of Project Web App. It allows the user to configure the settings for a list of parameters that specify paging, the enabling of various querying functionality, whether MaxResultsPerCollection has been enabled and whether verbose errors are enabled. Paging can be specified per entity. -If no paging overrides exist for a given entity, the DefaultMaxPageSize parameter is used. +If no paging overrides exist for a given entity, the DefaultMaxPageSize parameter is used. MaxResultsPerCollection cannot be used in conjunction with paging. For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Set-SPProjectOdataConfiguration -ClearEntityPageSizeOverrides ``` This example clears any page size overrides that have been set for any specific entities. - -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Set-SPProjectOdataConfiguration -AcceptProjectionRequests $true ``` This example sets AcceptProjectionRequests to true. - -### ----------------------EXAMPLE 3----------------------- +### EXAMPLE 3 ```powershell Set-SPProjectOdataConfiguration -DefaultMaxPageSize 50 ``` This example sets the default maximum page size to 50 rows. - -### ----------------------EXAMPLE 4----------------------- +### EXAMPLE 4 ```powershell Set-SPProjectOdataConfiguration -EntitySetName Assignments -PageSizeOverride 100 ``` This example sets the page size override for the Assignments entity. - ## PARAMETERS ### -AcceptCountRequests + +> Applicable: SharePoint Server Subscription Edition + Sets whether requests with the $count path segment or the $inlinecount query options are accepted. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,14 +81,16 @@ Accept wildcard characters: False ``` ### -AcceptProjectionRequests -Sets whether projection requests should be accepted. + +> Applicable: SharePoint Server Subscription Edition + +Sets whether projection requests should be accepted. Projection requests are made by using the $select query option. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +100,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +114,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,13 +124,15 @@ Accept wildcard characters: False ``` ### -ClearEntityPageSizeOverrides + +> Applicable: SharePoint Server Subscription Edition + Clears all page-size overrides that had been set for any entities. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,14 +142,16 @@ Accept wildcard characters: False ``` ### -DefaultMaxPageSize -Sets the default page size. + +> Applicable: SharePoint Server Subscription Edition + +Sets the default page size. This is used for any entities that do not have an override set using the PageSizeOverride parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,13 +161,15 @@ Accept wildcard characters: False ``` ### -EntitySetName + +> Applicable: SharePoint Server Subscription Edition + Specifies the entity name that is used to set a page size override with PageSizeOverride. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,14 +179,16 @@ Accept wildcard characters: False ``` ### -MaxResultsPerCollection + +> Applicable: SharePoint Server Subscription Edition + Sets the integer value that indicates the maximum number of results per entity. This parameter cannot be used in conjunction with paging. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -189,13 +198,15 @@ Accept wildcard characters: False ``` ### -PageSizeOverride + +> Applicable: SharePoint Server Subscription Edition + Overrides the page size that is used for a specific entity. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,13 +216,15 @@ Accept wildcard characters: False ``` ### -UseVerboseErrors + +> Applicable: SharePoint Server Subscription Edition + Sets the service to use more verbose error messages (for example, stack trace). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPCSSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPCSSettings.md index 12e78d8ba..0e984f9d6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPCSSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPCSSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectpcssettings -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectPCSSettings schema: 2.0.0 --- @@ -29,27 +29,27 @@ The settings have maximum and minimum values that are enforced by Project Server For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPProjectPCSSettings -sa "Project Service Application" -MaximumSessionsPerUser 500 ``` This example sets 500 as the maximum allowed Project Calculation Engine sessions that a user can open on the "Project Service Application" service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + The Project Server service application for which the settings are to be read. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,13 +83,15 @@ Accept wildcard characters: False ``` ### -CachePersistence + +> Applicable: SharePoint Server Subscription Edition + The maximum length of time before the Project Calculation Engine can begin to remove temporary cache files of projects opened on the Project Server service application. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +101,15 @@ Accept wildcard characters: False ``` ### -EditingSessionTimeout + +> Applicable: SharePoint Server Subscription Edition + The maximum length of time that a user can be idle in a Project Calculation Engine session before a timeout occurs. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,13 +119,15 @@ Accept wildcard characters: False ``` ### -MaximumIdleWorkersCount + +> Applicable: SharePoint Server Subscription Edition + The maximum number of idle Project Calculation Engine sessions available at a given time. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,13 +137,15 @@ Accept wildcard characters: False ``` ### -MaximumProjectSize + +> Applicable: SharePoint Server Subscription Edition + The maximum size of a project that can be opened by the Project Calculation Engine. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,13 +155,15 @@ Accept wildcard characters: False ``` ### -MaximumSessionsPerUser + +> Applicable: SharePoint Server Subscription Edition + The maximum number of sessions that a user is allowed to open. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -161,13 +173,15 @@ Accept wildcard characters: False ``` ### -MaximumWorkersCount + +> Applicable: SharePoint Server Subscription Edition + The maximum number of Project Calculation Engine sessions that can be created. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,13 +191,15 @@ Accept wildcard characters: False ``` ### -MinimumMemoryRequired + +> Applicable: SharePoint Server Subscription Edition + The minimum memory required before launching a new Project Calculation Engine session. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,13 +209,15 @@ Accept wildcard characters: False ``` ### -RequestTimeLimits + +> Applicable: SharePoint Server Subscription Edition + The maximum allowable time for a request to the Project Calculation Engine to complete before the Project Calculation Engine session is terminated. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -209,13 +227,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: SharePoint Server Subscription Edition + The TCP port to use with the PCS service. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPermissionMode.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPermissionMode.md index 683d5e70f..f35e0cd7b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPermissionMode.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectPermissionMode.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectpermissionmode -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectPermissionMode schema: 2.0.0 --- @@ -29,25 +29,26 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE 1------------------- +### EXAMPLE 1 ```powershell Set-SPPRojectPermissionMode -Url https://AppServer/pwa -Mode ProjectServer ``` This example shows the syntax for transitioning a server into Project Server permission mode. - -### --------------EXAMPLE 2------------------- +### EXAMPLE 2 ```powershell Set-SPPRojectPermissionMode -Url https://AppServer/pwa -Mode SharePoint ``` This example shows the syntax for transitioning a server into SharePoint permission mode. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance for which the permission mode is to be changed. The type must be a valid URL, in the form https://\/\. @@ -55,8 +56,7 @@ The type must be a valid URL, in the form https://\/\. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +66,9 @@ Accept wildcard characters: False ``` ### -Mode + +> Applicable: SharePoint Server Subscription Edition + Specifies the mode into which the instance should be changed. The type must be a valid permission mode, in the form SharePoint or ProjectServer. @@ -73,8 +76,7 @@ The type must be a valid permission mode, in the form SharePoint or ProjectServe ```yaml Type: PermissionMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -95,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectQueueSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectQueueSettings.md index 655c0142b..8083e9fb6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectQueueSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectQueueSettings.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectqueuesettings -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectQueueSettings schema: 2.0.0 --- @@ -28,20 +28,21 @@ Sets the value of one or multiple Project Server Queue settings for a specific P For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833). - ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPProjectQueueSettings -ServiceApplication "Project Service Application" -MaxDegreeOfConcurrency 6 ``` This example sets a maximum of 6 for the number of jobs that can be processed at one time by the specified service application. - ## PARAMETERS ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Project Server service application to target. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectServiceApp1); or an instance of a valid PsiServiceApplication object. @@ -50,7 +51,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: PsiServiceApplicationPipeBind Parameter Sets: (All) Aliases: sa -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -60,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,6 +84,9 @@ Accept wildcard characters: False ``` ### -CleanupNonSuccessAgeLimit + +> Applicable: SharePoint Server Subscription Edition + This setting determines the age threshold at which any job in a completed, non-successful state (example: Failed But Not Blocking Correlation) can be purged when the Queue Cleanup job runs. The age of each job is determined by the completed date and time. For example, if a job was cancelled at 2/1/2007 10:41 p.m. @@ -93,8 +98,7 @@ Minimum: 1;Maximum: 100000;Default: 168 (7 days) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +108,9 @@ Accept wildcard characters: False ``` ### -CleanupSuccessAgeLimit + +> Applicable: SharePoint Server Subscription Edition + This setting determines the age threshold at which successful jobs can be purged when the Queue Cleanup job runs. The age of each job is determined by the completed date and time. For example, if a job succeeded at 2/1/2007 10:41 p.m. @@ -115,8 +122,7 @@ Minimum: 1;Maximum: 100000;Default: 24 (1 day) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,6 +132,9 @@ Accept wildcard characters: False ``` ### -MaxConnections + +> Applicable: SharePoint Server Subscription Edition + Maximum number of Queue connections allowed to be pending dispatch on the server. Default: 10 @@ -133,8 +142,7 @@ Default: 10 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -144,6 +152,9 @@ Accept wildcard characters: False ``` ### -MaxDegreeOfConcurrency + +> Applicable: SharePoint Server Subscription Edition + The Queue is multi-threaded, which enables multiple jobs to be processed at the same time. This setting limits the degree of concurrency of the queue. Note that this setting is per Project Server service application. @@ -153,8 +164,7 @@ Minimum: 1;Maximum: 10;Default: 4 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -164,6 +174,9 @@ Accept wildcard characters: False ``` ### -MsgRetryInterval + +> Applicable: SharePoint Server Subscription Edition + If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will wait for the Retry Interval to elapse and retry the job. Minimum: 0 (immediately retry);Maximum: 300000 (5 minutes);Default: 1000 (1 second) @@ -171,8 +184,7 @@ Minimum: 0 (immediately retry);Maximum: 300000 (5 minutes);Default: 1000 (1 seco ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,6 +194,9 @@ Accept wildcard characters: False ``` ### -MsgRetryLimit + +> Applicable: SharePoint Server Subscription Edition + If job processing fails due to transient issues (like a SQL Deadlock), instead of failing the job, the Queue will retry the job. The number of retries is bound by the Retry Limit. @@ -190,8 +205,7 @@ Minimum: 0 (no retries);Maximum: 100;Default: 5 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +215,9 @@ Accept wildcard characters: False ``` ### -PeriodicTasksInterval + +> Applicable: SharePoint Server Subscription Edition + There are a number of bookkeeping tasks executed by the Queue System. Some examples are awakening jobs in 'Sleeping' state, updating the heartbeat timestamp, checking whether Queue Cleanup needs to be executed and so on. This setting controls the time interval at which these tasks run. @@ -210,8 +227,7 @@ Minimum: 500 (1/2 second);Maximum: 300000 (5 minutes);Default: 10000 (10 second) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,6 +237,9 @@ Accept wildcard characters: False ``` ### -QueueTimeout + +> Applicable: SharePoint Server Subscription Edition + The Queue System has a failover recovery feature. If the farm contains multiple servers running the Project Server Application Service and the Queue Service fails on one server, jobs are automatically redistributed to other servers on which the Queue Service is online. A Queue Service is considered to have timed out if it cannot be accessed from the Queue health timer job for more than the 'Queue Timeout' interval. @@ -230,8 +249,7 @@ Minimum: 5 minutes;Maximum: 60 minutes;Default: 15 minutes ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -241,6 +259,9 @@ Accept wildcard characters: False ``` ### -SqlCommandTimeout + +> Applicable: SharePoint Server Subscription Edition + The Queue makes SQL calls for retrieving and executing jobs. This setting controls the timeout value for all such calls. If any job fails due to a SQL Timeout error, administrators can increase this setting and retry the job. @@ -250,8 +271,7 @@ Minimum: 30 seconds;Maximum: 86400 (1 day);Default: 1800 (30 minutes) ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -261,6 +281,9 @@ Accept wildcard characters: False ``` ### -SqlRetryInterval + +> Applicable: SharePoint Server Subscription Edition + If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will wait for the SQL Retry Interval to elapse and retry the query. Minimum: 0 (immediately retry);Maximum: 60000 (1 minute);Default: 1000 (1 second) @@ -268,8 +291,7 @@ Minimum: 0 (immediately retry);Maximum: 60000 (1 minute);Default: 1000 (1 second ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -279,6 +301,9 @@ Accept wildcard characters: False ``` ### -SqlRetryLimit + +> Applicable: SharePoint Server Subscription Edition + If the Queue fails to connect to a Project Web App database due to a transient SQL problem (like a SQL Deadlock), the Queue will retry the query after the SQL Retry Interval has elapsed. The number of retries is bound by the SQL Retry Limit. @@ -287,8 +312,7 @@ Minimum: 0 (no retries)Maximum: 100Default: 5 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -298,13 +322,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: SharePoint Server Subscription Edition + Sets the TCP port the Project Queue service uses. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectServiceApplication.md index 51ae201b9..ecd3f25d6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectServiceApplication.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectserviceapplication -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectServiceApplication schema: 2.0.0 --- @@ -27,17 +27,19 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set- SPProjectServiceApplication -Identity PSIServiceApp -ApplicationPool newapppool RegisterTimerJob ``` This example updates the application pool and re-registers the timer job for a Project Server Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Project Server Service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Project Server service application (for example, ProjectWebApp1); or an instance of a valid PsiServiceApplication object. @@ -45,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool to run the web service in for the service application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -63,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSync.md index 5e177b249..1f5388ccb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSync.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectusersync -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectUserSync schema: 2.0.0 --- @@ -29,24 +29,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPProjectUserSync https://localhost/pwa EnablePWA ``` In this example, WSS User sync is enabled for the Project Web App site at https://localhost/pwa. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance to set the Project User Sync settings. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -56,13 +57,15 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: SharePoint Server Subscription Edition + Disabled completely disables WSS User Sync; EnablePWA enables WSS User sync for the Project Web App site; EnableEntProj enables WSS User sync for all SharePoint sites connected to Enterprise Projects; EnableSPProj enables WSS User sync for all SharePoint sites connected to SharePoint Projects; EnableAll enables WSS User sync for the Project Web App site and all connected SharePoint sites. ```yaml Type: UserSyncParameterValues[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -83,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncDisabledSyncThreshold.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncDisabledSyncThreshold.md index cc40bf07b..f362755e9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncDisabledSyncThreshold.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncDisabledSyncThreshold.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectusersyncdisabledsyncthreshold -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectUserSyncDisabledSyncThreshold schema: 2.0.0 --- @@ -32,24 +32,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPProjectUserSyncDisabledSyncThreshold -URL http//contoso-AppSrv/PWA -Threshold 400 ``` This example sets the sync disable threshold for the Project Web App instance at http//contoso-AppSrv/PWA to 400. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server Subscription Edition + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncFullSyncThreshold.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncFullSyncThreshold.md index 7f0f10e59..225ef53fa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncFullSyncThreshold.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncFullSyncThreshold.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectusersyncfullsyncthreshold -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectUserSyncFullSyncThreshold schema: 2.0.0 --- @@ -32,24 +32,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPProjectUserSyncFullSyncThreshold -URL https://contoso-AppSrv/ -Threshold 800 ``` This example sets the full user sync threshold for the Project Web App instance at https://contoso-AppSrv/PWA to 800. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server Subscription Edition + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncOffPeakSyncThreshold.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncOffPeakSyncThreshold.md index 6bfbf1a0d..2c20663e5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncOffPeakSyncThreshold.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPProjectUserSyncOffPeakSyncThreshold.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spprojectusersyncoffpeaksyncthreshold -Applicable: SharePoint Server Subscription Edition + title: Set-SPProjectUserSyncOffPeakSyncThreshold schema: 2.0.0 --- @@ -32,24 +32,25 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPProjectUserSyncOffPeakSyncThreshold -URL https://contoso/PWA -Threshold 900000 ``` This example sets the sync off-peak threshold for the Project Web App instance at https://contoso-AppSrv/PWA to 900000. - ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + The URL of the Project Web App instance where you want to set the threshold. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -59,13 +60,15 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server Subscription Edition + A whole number consisting of the number of projects multiplied by the number of users. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRemoteShareBlobStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRemoteShareBlobStore.md index 4544adce5..2c11c7ad4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRemoteShareBlobStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRemoteShareBlobStore.md @@ -25,14 +25,14 @@ The \`Set-SPRemoteShareBlobStore\` cmdlet changes the setting of the registed Re ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Set-SPRemoteShareBlobStore -RemoteShareBlobStore "RemoteStore" -Location "\\storage_name\blobstore\" ``` This example sets the location of Remote Share BLOB Store "RemoteStore" to "\\\\storage_name\blobstore\" -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Set-SPRemoteShareBlobStore -RemoteShareBlobStore "RemoteStore" -BlobStoreCredential (Get-Credential) ``` @@ -42,6 +42,9 @@ This example prompts the user to provide BLOB store credentials for the specifie ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,7 +56,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ``` ### -BlobStoreCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use to connect to the BLOB store. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -79,6 +83,9 @@ Accept wildcard characters: False ``` ### -Location + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the SMB storage this BLOB store will use. You must use a Universal Naming Convention (UNC) share path. For example: \\\\storage_name\blobstore. @@ -87,7 +94,6 @@ For example: \\\\storage_name\blobstore. Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +103,9 @@ Accept wildcard characters: False ``` ### -PoolCapacity + +> Applicable: SharePoint Server Subscription Edition + The number of BLOB trunks in each BLOB pool. If this parameter is not specified, the current value will not be changed. @@ -105,7 +114,6 @@ If this parameter is not specified, the current value will not be changed. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -RemoteShareBlobStore + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Remote Share BLOB Store to unregister. It can either be the Remote Share BLOB Store object or the Remote Share BLOB Store name. @@ -123,7 +134,6 @@ It can either be the Remote Share BLOB Store object or the Remote Share BLOB Sto Type: SPRemoteShareBlobStorePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -133,13 +143,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -149,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -156,7 +171,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRequestManagementSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRequestManagementSettings.md index b0a24a90c..a28aac874 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRequestManagementSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRequestManagementSettings.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets Request Manager properties. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $wa = Get-SPWebApplication https://webAppUrl $req = $wa | Get-SPRequestManagementSettings @@ -40,13 +39,15 @@ This example disables throttling on the specified Web Application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Request Manager object for which settings will be applied. ```yaml Type: SPRequestManagementSettingsPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -63,8 +67,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -RoutingEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether routing is enabled or disabled for the Request Manager object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -RoutingScheme + +> Applicable: SharePoint Server Subscription Edition + Specifies the routing scheme. The value is one of the following: @@ -101,8 +109,7 @@ The value is one of the following: ```yaml Type: SPRoutingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,13 +119,15 @@ Accept wildcard characters: False ``` ### -ThrottlingEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether throttling is enabled or disabled for the Request Manager object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachineInfo.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachineInfo.md index c771d79b1..42172ece3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachineInfo.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachineInfo.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets routing target properties. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $wa = Get-SPWebApplication -Identity https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -42,13 +41,15 @@ This example sets the "Availability" routing target property to Unavailable for ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingMachineInfoPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Availability + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not the specified computer will be available for routing. The valid values are: @@ -90,8 +96,7 @@ The valid values are: ```yaml Type: SPRoutingMachineAvailability Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -ClearOutgoingPort + +> Applicable: SharePoint Server Subscription Edition + Clears the outgoing port if it is set. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,14 +124,15 @@ Accept wildcard characters: False ``` ### -OutgoingPort -Specifies the port used by Request Manager to make an outgoing connection. +> Applicable: SharePoint Server Subscription Edition + +Specifies the port used by Request Manager to make an outgoing connection. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,6 +142,9 @@ Accept wildcard characters: False ``` ### -OutgoingScheme + +> Applicable: SharePoint Server Subscription Edition + Determines the schema of outgoing connections. The valid values are: @@ -145,8 +156,7 @@ The valid values are: ```yaml Type: SPRoutingOutgoingScheme Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,14 +166,16 @@ Accept wildcard characters: False ``` ### -StaticWeight + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the static weight of a computer routing is used by Request Manager. If the static weight is higher, more requests will be routed to the computer. ```yaml Type: Double Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachinePool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachinePool.md index d51d2e8a0..264d64f56 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachinePool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingMachinePool.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a machine pool. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $wa = Get-SPWebApplication -Identity https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -41,13 +40,15 @@ This example sets the routing machine pool on the specified Web Application. Usi ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +82,15 @@ Accept wildcard characters: False ``` ### -MachineTargets + +> Applicable: SharePoint Server Subscription Edition + Specifies the routing targets collection that the machine pool will contain. ```yaml Type: SPRoutingRuleTargetPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingRule.md index d1b681f77..7c85937dd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPRoutingRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes properties of an existing routing rule. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the `Set-SPRoutingRule` cmdlet to change properties of an existing routing r For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $wa = Get-SPWebApplication https://webAppUrl $rm = Get-SPRequestManagementSettings -Identity $wa @@ -44,17 +42,18 @@ Set-SPRoutingRule -Identity $rule -Criteria $criteriaNew This example sets a routing rule for the specified identity by using the $rule variable. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the request management settings object to set. ```yaml Type: SPRoutingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -71,8 +73,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -82,13 +83,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server Subscription Edition + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,13 +101,15 @@ Accept wildcard characters: False ``` ### -ExecutionGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the group in which the rule will be placed. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +137,15 @@ Accept wildcard characters: False ``` ### -MachinePool + +> Applicable: SharePoint Server Subscription Edition + Specifies the pool of machines to which a request will be routed if the changed rule is matched. ```yaml Type: SPRoutingMachinePoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataRange.md index 8a4cc2c79..818e2f5ea 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataRange.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Extends the range of a specified scale-out database. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the `Set-SPScaleOutDatabaseDataRange` cmdlet to extend the range of a specif For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -39,17 +37,18 @@ Set-SPScaleOutDatabaseDataRange -Database $database -Range $state.Range -NewRang This example extends the data range end point of the first database in the specified service application up to the maximum range point. - ## PARAMETERS ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to which to extend the data range. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to set the start or the end point of the data range with the specified value in the NewRangePoint parameter. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,13 +76,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server Subscription Edition + Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +94,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +108,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -NewRangePoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the new start or end point of the database. The maximum value is NULL. @@ -137,8 +147,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataSubRange.md index a42a6f777..e6acfabda 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataSubRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPScaleOutDatabaseDataSubRange.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a subrange for a specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -37,10 +36,9 @@ A subrange is a subset of a range of data. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -50,17 +48,18 @@ Set-SPScaleOutDatabaseDataSubRange -Database $database -Range $state.Range -SubR This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - ## PARAMETERS ### -ConnectionString + +> Applicable: SharePoint Server Subscription Edition + Specifies the connection string for the scale-out database to create the new data sub-range. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -70,13 +69,15 @@ Accept wildcard characters: False ``` ### -Database + +> Applicable: SharePoint Server Subscription Edition + Specifies the scale-out database to create the data subrange. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,13 +87,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to create the data subrange on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -102,13 +105,15 @@ Accept wildcard characters: False ``` ### -Range + +> Applicable: SharePoint Server Subscription Edition + Specifies the expected current range of the scale-out database prior to this operation. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -SubRangeMode + +> Applicable: SharePoint Server Subscription Edition + Specifies the mode of the data subrange to be created. The data subrange mode values are the following: @@ -129,8 +137,7 @@ The data subrange mode values are the following: ```yaml Type: SPScaleOutDatabaseSubRangeMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -151,8 +161,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -169,7 +181,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -179,14 +190,16 @@ Accept wildcard characters: False ``` ### -IgnoreSubRangePointOnBoundary + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -196,13 +209,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the database is hosted on SQL Azure. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -212,6 +227,9 @@ Accept wildcard characters: False ``` ### -SubRangePoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the start or end point of the data subrange to be created as defined by the following criteria: --The start point if the data sub-range is created on the upper side of the data range. @@ -222,8 +240,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -233,6 +250,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -240,7 +260,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreApplication.md index 423d24483..7f8f9fe36 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a Secure Store application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ The `Set-SPSecureStoreApplication` cmdlet sets properties of a Secure Store appl For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $targetApp.FriendlyName = "Updated Contoso Target App" Set-SPSecureStoreApplication -Identity $application -TargetApplication $targetApp @@ -38,17 +36,18 @@ Set-SPSecureStoreApplication -Identity $application -TargetApplication $targetAp This example sets a new display name Updated Contoso Target App for the target application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Store application to update. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -Administrator + +> Applicable: SharePoint Server Subscription Edition + Specifies the administrator of the Secure Store application. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -CredentialsOwnerGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies the claims object for the groups that own the group credentials. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,14 +136,16 @@ Accept wildcard characters: False ``` ### -Fields + +> Applicable: SharePoint Server Subscription Edition + Specifies the field information for the application. The default fields are username and password. ```yaml Type: TargetApplicationField[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,13 +155,15 @@ Accept wildcard characters: False ``` ### -TargetApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the target application. ```yaml Type: TargetApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -162,13 +173,15 @@ Accept wildcard characters: False ``` ### -TicketRedeemer + +> Applicable: SharePoint Server Subscription Edition + Specifies the ticket redeemer claim value. ```yaml Type: SPClaim[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -185,7 +201,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreDefaultProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreDefaultProvider.md index 8945faff5..cba236b25 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreDefaultProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreDefaultProvider.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the secure store provider. - ## SYNTAX ``` @@ -28,10 +27,9 @@ You can then set the secure store provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell [Reflection.Assembly]::LoadFrom("C:\ContosoFolder\contosoSecureStore.dll") $type = [Contoso.SecureStore.ContosoSecureStoreProvider] @@ -40,17 +38,18 @@ Set-SPSecureStoreDefaultProvider -Type $type This example sets the custom implemented secure store provider. - ## PARAMETERS ### -Type + +> Applicable: SharePoint Server Subscription Edition + The type must be a secure store provider type enclosed in square brackets; for example, \[Reflection.Assembly\]. ```yaml Type: Type Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -71,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreServiceApplication.md index f476198a5..5be9ab348 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecureStoreServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a Secure Store Service application in the farm. - ## SYNTAX ``` @@ -28,27 +27,27 @@ The `Set-SPSecureStoreServiceApplication` cmdlet sets properties of a Secure Sto For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Set-SPSecureStoreServiceApplication -Identity $contosoServApp -AuditlogMaxSize 40 ``` This example sets the maximum size of the audit log to 40 days for the given service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to update. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,13 +57,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS application pool to run the Web service in for the new service application. ```yaml Type: SPIisWebServiceApplicationPool Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,13 +99,15 @@ Accept wildcard characters: False ``` ### -AuditingEnabled + +> Applicable: SharePoint Server Subscription Edition + Turns on auditing for the Secure Store Service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -AuditlogMaxSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days to retain the audit log. The type must be a valid integer. @@ -119,8 +127,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,6 +137,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +147,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -179,14 +192,16 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -196,13 +211,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -212,14 +229,16 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -229,13 +248,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the failover database server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -245,13 +266,15 @@ Accept wildcard characters: False ``` ### -Sharing + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Store Service application is published and shared across the farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -261,6 +284,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -268,7 +294,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecurityTokenServiceConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecurityTokenServiceConfig.md index 1cff4735d..4073f5fd0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecurityTokenServiceConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSecurityTokenServiceConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the settings of the SharePoint security token service (STS) identity provider. - ## SYNTAX ### QueueSigningCertificateReference @@ -82,18 +81,16 @@ To create a certificate which can be used in this cmdlet specify the X509KeyStor For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPSecurityTokenServiceConfig -SigningCertificateThumbprint "2796BAE63F1801E277261BA0D77770028F20EEE4" ``` This example updates the signing certificate of the SharePoint security token service (STS) identity provider with a certificate that has been deployed in the certificate store. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell $stsCert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 "c:\sts.pfx","a",20 Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert @@ -101,17 +98,18 @@ Set-SPSecurityTokenServiceConfig -ImportSigningCertificate $stsCert This example imports the signing certificate for the SharePoint STS identity provider. - ## PARAMETERS ### -QueueSigningCertificateThumbprint + +> Applicable: SharePoint Server Subscription Edition + Sets the certificate with the provided thumbprint as the queued signing certificate. ```yaml Type: String -Parameter Sets: QueueSigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: QueueSigningCertificateReference, SigningCertificateReference +Aliases: Required: True Position: Named @@ -120,27 +118,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +### -RevokeSigningCertificateThumbprint -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -RevokeSigningCertificateThumbprint Revoke the signing certificate with the provided thumbprint. ```yaml Type: String Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -150,6 +137,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateThumbprint + +> Applicable: SharePoint Server Subscription Edition + Specifies the thumbrpint of the signing certificate. The type must be a valid identity of a signing certificate; for example 2796BAE63F1801E277261BA0D77770028F20EEE4. @@ -157,8 +147,7 @@ The type must be a valid identity of a signing certificate; for example 2796BAE6 ```yaml Type: String Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -168,6 +157,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -179,8 +171,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -190,6 +181,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -197,7 +191,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -207,6 +200,9 @@ Accept wildcard characters: False ``` ### -FormsTokenLifetime + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration time, in minutes, for tokens issued to ASP.NET Membership Provider and Role providers. The default value is 1380. @@ -215,8 +211,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -226,6 +221,9 @@ Accept wildcard characters: False ``` ### -ImportSigningCertificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -233,8 +231,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateImport -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -244,6 +241,9 @@ Accept wildcard characters: False ``` ### -MaxLogonTokenCacheItems + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of entries for the in-memory logon token cache. The default value is 250 entries. @@ -252,8 +252,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -263,6 +262,9 @@ Accept wildcard characters: False ``` ### -MaxServiceTokenCacheItems + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of entries for the in-memory service token cache. The default value is 250 entries. @@ -271,8 +273,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -282,13 +283,15 @@ Accept wildcard characters: False ``` ### -QueueSigningCertificate + +> Applicable: SharePoint Server Subscription Edition + Sets the provided certificate as the queued signing certificate. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateQueue -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -298,13 +301,15 @@ Accept wildcard characters: False ``` ### -QueueSigningCertificateStoreName + +> Applicable: SharePoint Server Subscription Edition + The store to search in when looking up a certificate to be set as the queued signing certificate by its thumbprint. Required if QueueSigningCertificateThumbprint was specified. ```yaml Type: String Parameter Sets: QueueSigningCertificateReference, SigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -314,13 +319,15 @@ Accept wildcard characters: False ``` ### -RevokeSigningCertificate + +> Applicable: SharePoint Server Subscription Edition + Revokes the signing certificate that matches the provided certificate. ```yaml Type: X509Certificate2 Parameter Sets: SigningCertificateRevoke -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -330,13 +337,15 @@ Accept wildcard characters: False ``` ### -RevokeSigningCertificateStoreName + +> Applicable: SharePoint Server Subscription Edition + The store to search when looking up a certificate to be revoked by its thumbprint. Required if the QueueSigningCertificateThumbprint was specified. ```yaml Type: String Parameter Sets: RevokeSigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -346,6 +355,9 @@ Accept wildcard characters: False ``` ### -ServiceTokenCacheExpirationWindow + +> Applicable: SharePoint Server Subscription Edition + Specifies the interval, in minutes, for automatically renewing the token in the cache. The default value is 2 minutes. @@ -354,8 +366,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -365,6 +376,9 @@ Accept wildcard characters: False ``` ### -ServiceTokenLifetime + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration time, in minutes, for the security token service cache. The default value is 15 minutes. @@ -373,8 +387,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -384,6 +397,9 @@ Accept wildcard characters: False ``` ### -SigningCertificateStoreName + +> Applicable: SharePoint Server Subscription Edition + Specifies the certificate store where the signing certificate resides. The identity store for an identity provider can be a SQL database table, an Active Directory Domain Services (AD DS), or Active Directory Lightweight Directory Service (AD LDS). @@ -392,8 +408,7 @@ The type must be a valid identity of a signing certificate store; for example Id ```yaml Type: String Parameter Sets: SigningCertificateReference -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -403,6 +418,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -410,7 +428,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -420,6 +437,9 @@ Accept wildcard characters: False ``` ### -WindowsTokenLifetime + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration time, in minutes, for tokens issued to Windows users. The default value is 1380 minutes. @@ -428,8 +448,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServer.md index 254cd0503..fc05decc5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServer.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/set-spserver -Applicable: SharePoint Server Subscription Edition + title: Set-SPServer schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes the role of the server. - ## SYNTAX ``` @@ -23,29 +22,29 @@ Set-SPServer [-Identity] [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**NOTE**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -55,13 +54,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the server in the farm. ```yaml Type: SPServerPipeBind Parameter Sets: (All) Aliases: Address -Applicable: SharePoint Server Subscription Edition Required: True Position: 0 @@ -71,7 +72,10 @@ Accept wildcard characters: False ``` ### -Role -Specifies the name of the server role you want to change. + +> Applicable: SharePoint Server Subscription Edition + +Specifies the name of the server role you want to change. The valid values are: @@ -84,13 +88,11 @@ The valid values are: * ApplicationWithSearch * WebFrontEndWithDistributedCache - ```yaml Type: SPServerRole Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,14 +102,16 @@ Accept wildcard characters: False ``` ### -Status + +> Applicable: SharePoint Server Subscription Edition + Sets the status of the server in the farm. ```yaml Type: SPObjectStatus Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Online, Disabled, Offline, Unprovisioning, Provisioning, Upgrading, Patching -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataRange.md index 864e65033..cef458c5f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataRange.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Extends the range of a specified scale-out database. - ## SYNTAX ``` @@ -24,10 +23,9 @@ Set-SPServerScaleOutDatabaseDataRange -Database -IsUpperSub ## DESCRIPTION Use the Set-SPServerScaleOutDatabaseDataRange cmdlet to extend the range of a specified scale-out database in a specified direction. - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -37,18 +35,18 @@ Set-SPServerScaleOutDatabaseDataRange -Database $database -Range $state.Range -N This example extends the data range end point of the first database in the specified service application up to the maximum range point. - ## PARAMETERS ### -Database -Specifies the scale-out database to which to extend the data range. +> Applicable: SharePoint Server Subscription Edition + +Specifies the scale-out database to which to extend the data range. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,14 +56,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange -Specifies whether to set the start point or the end point of the data range with the specified value in the NewRangePoint parameter. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether to set the start point or the end point of the data range with the specified value in the NewRangePoint parameter. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,14 +74,15 @@ Accept wildcard characters: False ``` ### -Range -Specifies the expected data range of the scale-out database. +> Applicable: SharePoint Server Subscription Edition + +Specifies the expected data range of the scale-out database. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -92,16 +92,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server Subscription Edition + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -111,14 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,14 +130,16 @@ Accept wildcard characters: False ``` ### -NewRangePoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the new start point or end point of the database. The maximum value is NULL. ``yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,15 +149,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataSubRange.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataSubRange.md index 895bd4860..5ffe72e6d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataSubRange.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServerScaleOutDatabaseDataSubRange.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a subrange for a specified scale-out database. - ## SYNTAX ### UnattachedDatabase @@ -34,10 +33,9 @@ Set-SPServerScaleOutDatabaseDataSubRange -Database -IsUpper ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets] (https://msdn.microsoft.com/library/dd878348(VS.85).aspx). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -48,18 +46,18 @@ Set-SPServerScaleOutDatabaseDataSubRange -Database $database -Range $state.Range This example creates a read-only subrange that starts from the data range start point and ends at the data range end point on the first scale-out database of the specified service application. - ## PARAMETERS ### -ConnectionString -Specifies the connection string for the scale-out database to create the new data sub-range. +> Applicable: SharePoint Server Subscription Edition + +Specifies the connection string for the scale-out database to create the new data sub-range. ```yaml Type: String Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -69,14 +67,15 @@ Accept wildcard characters: False ``` ### -Database -Specifies the scale-out database to create the data subrange. +> Applicable: SharePoint Server Subscription Edition + +Specifies the scale-out database to create the data subrange. ```yaml Type: SPDatabasePipeBind Parameter Sets: AttachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,14 +85,15 @@ Accept wildcard characters: False ``` ### -IsUpperSubRange -Specifies whether to create the data subrange on the upper or lower side of the data range. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether to create the data subrange on the upper or lower side of the data range. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -103,14 +103,15 @@ Accept wildcard characters: False ``` ### -Range -Specifies the expected current range of the scale-out database prior to this operation. +> Applicable: SharePoint Server Subscription Edition + +Specifies the expected current range of the scale-out database prior to this operation. ```yaml Type: SPScaleOutDataRange Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -121,14 +122,14 @@ Accept wildcard characters: False ### -SubRangeMode +> Applicable: SharePoint Server Subscription Edition ```yaml Type: SPScaleOutDatabaseSubRangeMode Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -138,16 +139,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server Subscription Edition + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,14 +159,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -174,14 +177,15 @@ Accept wildcard characters: False ``` ### -IgnoreSubRangePointOnBoundary -Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether to complete without any errors if the new subrange's start and end points are the same. If this parameter is specified, no errors are displayed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,14 +195,15 @@ Accept wildcard characters: False ``` ### -IsAzureDatabase -Specifies whether the database is hosted on SQL Azure. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether the database is hosted on SQL Azure. ```yaml Type: SwitchParameter Parameter Sets: UnattachedDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -208,7 +213,10 @@ Accept wildcard characters: False ``` ### -SubRangePoint -Specifies the start or end point of the data subrange to be created as defined by the following criteria: + +> Applicable: SharePoint Server Subscription Edition + +Specifies the start or end point of the data subrange to be created as defined by the following criteria: --The start point if the data sub-range is created on the upper side of the data range. --The end point if the data sub-range is created on the lower side of the data range. @@ -218,8 +226,7 @@ The maximum value is NULL. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -229,15 +236,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplication.md index 8d555cbd1..66434eb77 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a service application. - ## SYNTAX ``` @@ -28,10 +27,9 @@ Use the `Set-SPServiceApplication` cmdlet to set various properties of a service For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE---------------- +### EXAMPLE ```powershell $serviceapp = Get-SPServiceApplication "My Service App" Set-SPServiceApplication $serviceapp -DefaultEndpoint https @@ -39,10 +37,12 @@ Set-SPServiceApplication $serviceapp -DefaultEndpoint https This example sets the default endpoint of the service application to be https. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPServiceApplication object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,13 +60,15 @@ Accept wildcard characters: False ``` ### -DefaultEndpoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the address of the default endpoint of the service application. ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -IisWebServiceApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or identity of the application pool used by the service application. The IisWebServiceApplicationPool parameter only applies to Web Service applications. @@ -106,8 +112,7 @@ The IisWebServiceApplicationPool parameter only applies to Web Service applicati ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If the ServiceApplicationProxyGroup parameter is not specified, the farm's default proxy group is used. @@ -124,8 +132,7 @@ If the ServiceApplicationProxyGroup parameter is not specified, the farm's defau ```yaml Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +142,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -152,6 +161,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -159,7 +171,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationEndpoint.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationEndpoint.md index 8f3723225..7f4ec88ca 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationEndpoint.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationEndpoint.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the host of an endpoint for a service application. - ## SYNTAX ### HostName @@ -37,20 +36,21 @@ Use the second parameter set to reset the host of the service endpoint to use th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE------------------- +### EXAMPLE ```powershell Set-SPServiceApplicationEndpoint -Identity "ServiceApp1" -HostName http://sitename -ResetHostName $true ``` This example associates the SPServiceEndpoint object with the specified identity and resets the hostname. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service endpoint to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object. @@ -58,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceEndpointPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -HostName + +> Applicable: SharePoint Server Subscription Edition + Specifies the default host of the service endpoint. The type must be a valid full load balanced URL, in the form http://server_name. @@ -76,8 +78,7 @@ The type must be a valid full load balanced URL, in the form http://server_name. ```yaml Type: String Parameter Sets: HostName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,13 +88,15 @@ Accept wildcard characters: False ``` ### -ResetHostName + +> Applicable: SharePoint Server Subscription Edition + Removes the current host of the service endpoint and uses the default host. ```yaml Type: SwitchParameter Parameter Sets: ResetHostName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -114,8 +120,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,6 +130,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -132,7 +140,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -142,6 +149,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +159,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationPool.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationPool.md index e578a6a58..2d35f8a6b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationPool.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationPool.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes the account used for the Identity of the specified application pool. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Set-SPServiceApplicationPool` cmdlet changes the account used for the Ident For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPServiceApplicationPool TestServiceWebApplicationPool -Account testdomain\testuser1 ``` @@ -40,17 +38,18 @@ For the Account parameter, the name of a managed account in the farm can be give Use the `Get-SPManagedAccount` cmdlet to view the existing managed account in the farm. Also, a process account from the output of the `Get-SPProcessAccount` cmdlet can be used. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Web service application pool to configure. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,13 +59,15 @@ Accept wildcard characters: False ``` ### -Account + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials that will be the new Identity of the application pool. ```yaml Type: SPProcessAccountPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 2 @@ -76,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -122,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationSecurity.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationSecurity.md index 67752ff28..aa0e37009 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationSecurity.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceApplicationSecurity.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the SPObjectSecurity object for a service application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Use this cmdlet with the `Grant-SPObjectSecurity` and `Get-SPServiceApplicationS For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication -Identity $security = Get-SPServiceApplicationSecurity $sa -Admin @@ -42,10 +40,12 @@ Set-SPServiceApplicationSecurity $sa -Admin $security This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the service application that contains the SPObjectSecurity object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object. @@ -53,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -64,13 +63,15 @@ Accept wildcard characters: False ``` ### -ObjectSecurity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPObjectSecurity object to update. ```yaml Type: SPObjectSecurity Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -80,13 +81,15 @@ Accept wildcard characters: False ``` ### -Admin + +> Applicable: SharePoint Server Subscription Edition + Updates the access control list (ACL) that contains the administrators list of the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -107,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceHostConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceHostConfig.md index c3bf43e53..4c7f97411 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceHostConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPServiceHostConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures one or more common settings for all web services. - ## SYNTAX ### SslCertificateImport (Default) @@ -46,20 +45,21 @@ The `Set- SPServiceHostConfig` cmdlet configures one or more common settings for For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPServiceHostConfig -Port 12345 ``` This example sets the HTTP port for the web services. - ## PARAMETERS ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -72,7 +72,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: SslCertificateImport, SslCertificateReference Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -82,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -93,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +105,15 @@ Accept wildcard characters: False ``` ### -HttpPort + +> Applicable: SharePoint Server Subscription Edition + Specifies the new port for the web service. ```yaml Type: Int32 Parameter Sets: SslCertificateImport, SslCertificateReference Aliases: Port -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -HttpsPort + +> Applicable: SharePoint Server Subscription Edition + Specifies the new secure port for the web service. ```yaml Type: Int32 Parameter Sets: SslCertificateImport, SslCertificateReference Aliases: SecurePort -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the web service application to configure. ```yaml Type: SPIisWebServiceSettings Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -152,13 +159,15 @@ Accept wildcard characters: False ``` ### -ImportSslCertificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the SSL Certificate to use for secure protocols. ```yaml Type: X509Certificate2 Parameter Sets: SslCertificateImport -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -168,13 +177,15 @@ Accept wildcard characters: False ``` ### -NetTcpPort + +> Applicable: SharePoint Server Subscription Edition + Sets the TCP port for the web service. ```yaml Type: Int32 Parameter Sets: SslCertificateImport, SslCertificateReference Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -184,13 +195,15 @@ Accept wildcard characters: False ``` ### -NoWait + +> Applicable: SharePoint Server Subscription Edition + For more information, see TechNet. ```yaml Type: SwitchParameter Parameter Sets: SslCertificateImport, SslCertificateReference Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -200,13 +213,15 @@ Accept wildcard characters: False ``` ### -RunInProcess + +> Applicable: SharePoint Server Subscription Edition + Specifies to update the web service application configuration using the current process instead of a SharePoint Timer job. ```yaml Type: SwitchParameter Parameter Sets: SslCertificateReferenceRunInProcess Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -SslCertificateStoreName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the certificate store containing the SSL certificate to retrieve for secure protocols. ```yaml Type: String Parameter Sets: SslCertificateReference, SslCertificateReferenceRunInProcess Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -232,13 +249,15 @@ Accept wildcard characters: False ``` ### -SslCertificateThumbprint + +> Applicable: SharePoint Server Subscription Edition + Specifies the thumbprint of the SSL certificate to retrieve for secure protocols. ```yaml Type: String Parameter Sets: SslCertificateReference, SslCertificateReferenceRunInProcess Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -248,6 +267,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -255,7 +277,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -265,6 +286,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -272,7 +296,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSessionStateService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSessionStateService.md index b01235b82..b69a4e185 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSessionStateService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSessionStateService.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the credentials that are used to communicate with the state service database. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Set-SPSessionStateService` cmdlet updates the credentials that are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPSessionStateService -SessionTimeout 120 ``` This example changes the ASP.NET session state time-out to 2 hours. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +50,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -68,7 +70,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the database credentials for SQL Authentication that are used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -86,8 +90,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -SessionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time, in minutes that an ASP.NET session will remain active with no user activity. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSite.md index 1dbf4fae2..b0416c4cc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the specified sites. - ## SYNTAX ### SiteSubscription @@ -43,28 +42,28 @@ The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and W For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Get-SPSite https://sitename/sites/teams/* | Set-SPSite -SecondaryOwner "DOMAIN\Jdoe" ``` This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPSite -identity "https://sitename" -MaxSize 4000000 -WarningSize 2000000 ``` This example configures the Quota settings for the site collection https://sitename. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to configure, or refers to an SPSite object that contains sites to configure. The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object. @@ -72,8 +71,7 @@ The type must be a valid URL, in the form https://server_name; a valid GUID, in ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -83,6 +81,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server Subscription Edition + Specifies the site type. Valid values are None or TentantAdministration. @@ -90,8 +91,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +101,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -112,8 +115,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -123,6 +125,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -130,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -140,14 +144,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter. ```yaml Type: SwitchParameter Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +163,9 @@ Accept wildcard characters: False ``` ### -LockState + +> Applicable: SharePoint Server Subscription Edition + Sets the lock state of this site collection. The valid lock states are @@ -173,8 +182,7 @@ Users who attempt to access the site receive an access-denied message. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -184,6 +192,9 @@ Accept wildcard characters: False ``` ### -MaxSize + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum storage size for the site collection in bytes. The integer value must be larger than the WarningSize value. @@ -192,8 +203,7 @@ You cannot use this parameter if the site collection is using a quota template. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -203,6 +213,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Specifies the alias name of the site collection administrator. The type must be a valid e-mail alias, in the form domain\username. @@ -210,8 +223,7 @@ The type must be a valid e-mail alias, in the form domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -221,6 +233,9 @@ Accept wildcard characters: False ``` ### -QuotaTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies the new quota template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef or a string @@ -228,8 +243,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef ```yaml Type: SPQuotaTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -239,6 +253,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Sets the alias of the secondary site collection administrator. The type must be a valid e-mail alias, in the form domain\username. @@ -246,8 +263,7 @@ The type must be a valid e-mail alias, in the form domain\username. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -257,13 +273,15 @@ Accept wildcard characters: False ``` ### -SharingType + +> Applicable: SharePoint Server Subscription Edition + Specifies whether external access a site collection should be disabled, limited to external users only, or enabled for external users and anonymous guests. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -273,13 +291,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -289,6 +309,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. @@ -296,8 +319,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -307,13 +329,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the new site. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -323,13 +347,15 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPath + +> Applicable: SharePoint Server Subscription Edition + Sets an organization unit to which to scope user accounts. ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -339,6 +365,9 @@ Accept wildcard characters: False ``` ### -WarningSize + +> Applicable: SharePoint Server Subscription Edition + Sets the storage warning level for the site collection in bytes. The integer value must be between 0 and the MaxSize value. @@ -347,8 +376,7 @@ You cannot use this parameter if the site collection is using a quota template. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -358,6 +386,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -365,7 +396,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteAdministration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteAdministration.md index 3781a1fdc..d83257ed9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteAdministration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteAdministration.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Allows farm administrators to configure any site collection. - ## SYNTAX ### SiteSubscription @@ -41,20 +40,21 @@ Any parameter that is not provided is not changed. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPSiteAdministration https://sitename -OwnerAlias "DOMAIN\NewOwner" ``` This example allows farm administrators to change the ownership of a site collection to which they do not have access. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL (full or partial) or GUID of the site collection. The type must be a valid URL, in the form https://server_name, or a GUID, in the form 1234-456-987fg. @@ -62,8 +62,7 @@ The type must be a valid URL, in the form https://server_name, or a GUID, in the ```yaml Type: SPSiteAdministrationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -73,6 +72,9 @@ Accept wildcard characters: False ``` ### -AdministrationSiteType + +> Applicable: SharePoint Server Subscription Edition + Specifies the site type. Valid values are None or TentantAdministration. @@ -80,8 +82,7 @@ Valid values are None or TentantAdministration. ```yaml Type: SPAdministrationSiteType Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,14 +135,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter. ```yaml Type: SwitchParameter Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -147,6 +154,9 @@ Accept wildcard characters: False ``` ### -LockState + +> Applicable: SharePoint Server Subscription Edition + Specifies the lock state for the given site collection. The type must be any of the following values: @@ -159,8 +169,7 @@ The type must be any of the following values: ```yaml Type: String Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -170,18 +179,19 @@ Accept wildcard characters: False ``` ### -MaxSize + +> Applicable: SharePoint Server Subscription Edition + Sets the maximum storage size of the site collection. The type must be a valid number greater than or equal to 0. Set to 0 for unlimited. - ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -191,6 +201,9 @@ Accept wildcard characters: False ``` ### -OwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Sets the owner of this site collection. The type must be a valid user alias. @@ -198,8 +211,7 @@ The type must be a valid user alias. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -209,6 +221,9 @@ Accept wildcard characters: False ``` ### -SecondaryOwnerAlias + +> Applicable: SharePoint Server Subscription Edition + Sets the secondary owner of this site collection. The type must be a valid user alias. @@ -216,8 +231,7 @@ The type must be a valid user alias. ```yaml Type: SPUserPipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -227,13 +241,15 @@ Accept wildcard characters: False ``` ### -SiteSubscription + +> Applicable: SharePoint Server Subscription Edition + Specifies the Site Group to get site collections. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: SiteSubscription -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,6 +259,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web template for the top-level Web site of this site collection. This can only be given if the template has not already been configured. @@ -251,8 +270,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef, ```yaml Type: SPWebTemplatePipeBind Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -262,6 +280,9 @@ Accept wildcard characters: False ``` ### -WarningSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection warning size limit. The type must be a valid number greater than or equal to 0. @@ -270,8 +291,7 @@ Set to 0 for unlimited. ```yaml Type: Int64 Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -281,6 +301,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -288,7 +311,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionConfig.md index d451c293f..afa2c11d2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the configuration properties of a site subscription. - ## SYNTAX ``` @@ -26,20 +25,21 @@ The `Set-SPSiteSubscriptionConfig` cmdlet sets the configuration properties of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPSiteSubscriptionConfig https://contoso.com -FeaturePack 12345678-90ab-cdef-1234-567890abcdef ``` This example sets the Feature set of the entire site subscription that contains https://contoso.com with a Feature pack GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription configuration to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. @@ -47,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server Subscription Edition + Specifies the output object can be passed through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +118,9 @@ Accept wildcard characters: False ``` ### -UserAccountDirectoryPath + +> Applicable: SharePoint Server Subscription Edition + Sets the site user account directory path to a specific organizational unit (OU) that is in the same domain as the site subscription. The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGCorp,DC=local. @@ -120,8 +128,7 @@ The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGC ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -138,7 +148,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -FeaturePack + +> Applicable: SharePoint Server Subscription Edition + {{Fill FeaturePack Description}} ```yaml Type: SPSiteSubscriptionFeaturePackPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionEdiscoveryHub.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionEdiscoveryHub.md index 4dc7c228d..69676fc61 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionEdiscoveryHub.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionEdiscoveryHub.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties for the eDiscovery hub of a site subscription. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Set-SPSiteSubscriptionEdiscoveryHub` cmdlet sets global properties and sett For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE-------------------- +### EXAMPLE ```powershell Set-SPSiteSubscriptionEdiscoverySearchScope -Site https://contoso.com/sites/sitecollection1 -SearchScope 1 ``` @@ -36,17 +34,18 @@ Set-SPSiteSubscriptionEdiscoverySearchScope -Site https://contoso.com/sites/site This example enables the search scope for the entire site subscription. A value of zero (0) disables the search scope across the entire site subscription. - ## PARAMETERS ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for the Ediscovery hub. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,14 +98,16 @@ Accept wildcard characters: False ``` ### -SearchScope + +> Applicable: SharePoint Server Subscription Edition + Specifies the name for the search scope. The default value is All Sites. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionIRMConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionIRMConfig.md index 0a7f22990..54c017da0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionIRMConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionIRMConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the Information Rights Management (IRM) settings. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the Identity parameter of the `Set-SPSiteSubscriptionIRMConfig` cmdlet to se For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell site = Get-SPSite HYPERLINK "https://" https:// $subscription = $site.SiteSubscription @@ -38,8 +36,7 @@ Set-SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled -Certificate This example enables IRM for the tenant and configures it to use the specified RMS server. - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell site = Get-SPSite HYPERLINK "https://myspserver" https:// $subscription = $site.SiteSubscription @@ -48,17 +45,18 @@ Set- SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled:$false This example disables IRM for the tenant. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a site subscription for a particular tenant. ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -68,6 +66,9 @@ Accept wildcard characters: False ``` ### -IrmEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies whether IRM is enabled in the tenant. The default value is false. @@ -75,8 +76,7 @@ The default value is false. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -86,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -97,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,13 +110,15 @@ Accept wildcard characters: False ``` ### -CertificateServerUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the address of the RMS certificate server to use for the tenant. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +128,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +138,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -141,13 +147,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: SharePoint Server Subscription Edition + Specifies that the output object can be passed through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +165,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -164,7 +175,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionMetadataConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionMetadataConfig.md index ddbf637f7..e5902812c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionMetadataConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionMetadataConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the site subscription configuration settings for a specified Metadata Service application. - ## SYNTAX ``` @@ -27,20 +26,21 @@ Use the `Set-SPSiteSubscriptionMetadataConfig` cmdlet to set the site subscripti For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPSiteSubscriptionMetadataConfig -Identity $siteSubscriptionPipeBind1 -ServiceProxy "MetadataServiceProxy2" -HubUri "https://sitename" -SyndicationErrorReportEnabled:$false ``` This example sets the content type syndication hub and disables syndication error reporting for a specific site subscription on an existing partitioned Metadata Service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site subscription for which to set the Metadata Service application settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -ServiceProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the local metadata service proxy for the service application that contains the site subscription-specific settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of the service application proxy (for example, ServiceAppProxy1); or an instance of a valid SPMetadataServiceProxy object. @@ -66,8 +68,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPMetadataServiceProxyCmdletPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -77,6 +78,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +92,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -106,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -116,13 +121,15 @@ Accept wildcard characters: False ``` ### -DoNotUnpublishAllPackages + +> Applicable: SharePoint Server Subscription Edition + {{ Fill DoNotUnpublishAllPackages description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -HubUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI of the syndication hub. The type must be a valid URI, in the form file:\\\\server_name\sitedocs. @@ -139,8 +149,7 @@ The type must be a valid URI, in the form file:\\\\server_name\sitedocs. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -SyndicationErrorReportEnabled + +> Applicable: SharePoint Server Subscription Edition + Enables error reporting for content type syndication. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionProfileConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionProfileConfig.md index 20ba40436..974e9f8b6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionProfileConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteSubscriptionProfileConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the parameters of a site subscription. - ## SYNTAX ### Default @@ -40,10 +39,9 @@ The `Set-SPSiteSubscriptionProfileConfig` cmdlet sets the parameters of a site s For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $sub = Get-SPSiteSubscription http://contoso/my Set-SPSiteSubscriptionProfileConfig -Identity $sub -SiteNamingConflictResolution 3 -SynchronizationOU OrgUnit1 @@ -51,10 +49,12 @@ Set-SPSiteSubscriptionProfileConfig -Identity $sub -SiteNamingConflictResolution This example sets the parameter of the site subscription SiteNamingConflictResolution to always avoid any conflicts and parameter SynchronizationOU to OrgUnit1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the User Profile Service application that contains the site subscription to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a User Profile Service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. @@ -62,8 +62,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSiteSubscriptionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -73,15 +72,17 @@ Accept wildcard characters: False ``` ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection where the My Site host for the site subscription is provisioned. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form https://server_name; or an instance of a valid SPSite object. ```yaml Type: SPSitePipeBind -Parameter Sets: Default -Aliases: -Applicable: SharePoint Server Subscription Edition +Parameter Sets: Default, MySiteSettings +Aliases: Required: False Position: Named @@ -90,27 +91,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSitePipeBind -Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +### -ProfileServiceApplicationProxy -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: SharePoint Server Subscription Edition -### -ProfileServiceApplicationProxy Specifies the name of the proxy for the User Profile Service application. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -120,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,8 +124,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -149,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -159,6 +153,9 @@ Accept wildcard characters: False ``` ### -MySiteManagedPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed path where personal sites will be created. The type must be a valid URL, in the form https://server_name. @@ -166,8 +163,7 @@ The type must be a valid URL, in the form https://server_name. ```yaml Type: SPPrefixPipeBind Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,6 +173,9 @@ Accept wildcard characters: False ``` ### -SiteNamingConflictResolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the format to use to name personal sites. Use one of the following integer values: @@ -195,8 +194,7 @@ The default value is 1 (do not resolve conflicts). ```yaml Type: String Parameter Sets: MySiteSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -206,6 +204,9 @@ Accept wildcard characters: False ``` ### -SynchronizationOU + +> Applicable: SharePoint Server Subscription Edition + Specifies the organizational unit that serves the site subscription. The type must be a valid name of an organizational unit; for example, OrgUnit1. @@ -213,8 +214,7 @@ The type must be a valid name of an organizational unit; for example, OrgUnit1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -224,6 +224,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -231,7 +234,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteURL.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteURL.md index 36aff24b6..dda37efd1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteURL.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSiteURL.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Adds or changes an URL mapping for the site. - ## SYNTAX ``` @@ -28,10 +27,9 @@ This cmdlet cannot be directly run against a managed path site collection undern For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $site = Get-SPSite 'http://www.contoso.com' Set-SPSiteURL -Identity $site -Url http://contoso.sharepoint.com -Zone 0 @@ -40,18 +38,19 @@ Set-SPSiteURL -Identity $site -Url http://contoso.sharepoint.com -Zone 0 This example adds an additional URL, http://contoso.sharepoint.com, to the site collection. The newly added URL is in the default zone. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site collection to set. Must be the root site collection for a host-name. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL. This must be unique. This must be an absolute URL including scheme (that is, https://www.contoso.com). @@ -70,8 +72,7 @@ Otherwise, the URL entry is added and cannot be in use by another site collectio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -92,8 +96,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -110,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +135,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -137,16 +144,17 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies one of the five zones with which the alternate URL is associated. If the Zone parameter is not specified and is a new entry, the default value is set. If an entry exists and is not specified, do not change. - ```yaml Type: SPUrlZone Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplication.md index 62317a875..eb865d32e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the name of a state service application. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The `Set-SPStateServiceApplication` cmdlet updates the name of a state service a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPStateServiceApplication -Identity "State Service Application 1" -Name "New name for State Service Application 1" ``` This example changes the display name of a state service application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to update. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -46,8 +46,7 @@ The type must be a valid name of a state service application (for example, State ```yaml Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the state service application. The type must be a valid name of a state service application; for example, StateSvc1. @@ -103,8 +109,7 @@ The type must be a valid name of a state service application; for example, State ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplicationProxy.md index ebc60bfcc..9e2f9745b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceApplicationProxy.md @@ -24,20 +24,21 @@ The `Set-SPStateServiceApplicationProxy` cmdlet updates the name of a state serv For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Set-SPServiceApplicationProxy -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Name "New Service Application Proxy Name" ``` This example changes the display name of a state service application proxy. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application proxy to update. The type must be a valid name of a state service application proxy (for example, StateServiceProxy); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplicationProxy object. @@ -45,8 +46,7 @@ The type must be a valid name of a state service application proxy (for example, ```yaml Type: SPStateServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,13 +80,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Confirm Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +98,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the display name of the state service application proxy. The type must be a valid name of a state service application; for example, StateSvcProxy1. @@ -101,8 +108,7 @@ The type must be a valid name of a state service application; for example, State ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -112,13 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + {{ Fill WhatIf Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceDatabase.md index e80e9ceef..3bb22d298 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPStateServiceDatabase.md @@ -25,26 +25,23 @@ The `Set-SPStateServiceDatabase` cmdlet manages the credentials that are used to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -Weight 10 ``` This example updates the database weight to the maximum (10). - -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -ServiceApplication "StateSvcApp1" ``` This example updates the associated service application for a state service database. - -### --------------------EXAMPLE 3--------------------- +### EXAMPLE 3 ```powershell $cred = Get-Credential Set-SPStateServiceDatabase -Identity "StateSvcDB1" -DatabaseCredentials $cred @@ -52,10 +49,12 @@ Set-SPStateServiceDatabase -Identity "StateSvcDB1" -DatabaseCredentials $cred This example updates the SQL Authentication credentials that are used for a given database. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service database to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -64,7 +63,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -74,6 +72,9 @@ Accept wildcard characters: False ``` ### -ServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the state service application to which to add the state database. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object. @@ -82,7 +83,6 @@ The type must be a valid name of a state service application (for example, State Type: SPStateServiceApplicationPipeBind Parameter Sets: (All) Aliases: Application -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 @@ -92,6 +92,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -103,8 +106,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +126,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -131,6 +135,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used. @@ -139,8 +146,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -150,6 +156,9 @@ Accept wildcard characters: False ``` ### -Weight + +> Applicable: SharePoint Server Subscription Edition + Specifies the weight for the state database. The default value is 1. @@ -158,8 +167,7 @@ The type must be a valid integer in the range of 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +177,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSubscriptionSettingsServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSubscriptionSettingsServiceApplication.md index feaae524d..11a36f994 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSubscriptionSettingsServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPSubscriptionSettingsServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a subscription settings service application. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Use the `Set-SPSubscriptionSettingsServiceApplication` cmdlet to set properties For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ---------------------EXAMPLE-------------------------- +### EXAMPLE ```powershell $applicationPool = GetServiceApplicationPool SettingsApplicationPool Get-SPServiceApplication -Name SettingsServiceApp | Set-SPSubscriptionSettingsServiceApplication -ApplicationPool $applicationPool @@ -39,10 +37,12 @@ Get-SPServiceApplication -Name SettingsServiceApp | Set-SPSubscriptionSettingsSe This example changes the application pool of the subscription settings service application. This command assumes that a subscription settings service application named SettingsServiceApp exists and that an application pool named SettingsApplicationPool exists - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the settings service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +84,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +94,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -107,8 +113,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the subscription settings database. The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsAppDB1. @@ -125,8 +133,7 @@ The type must be a valid name of a SQL Server database; for example, Subscriptio ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,6 +143,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL Server instance for the database specified in DatabaseName parameter. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -143,8 +153,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. @@ -161,8 +173,7 @@ The type must be a valid SQL Server instance name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,6 +183,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -179,7 +193,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPThrottlingRule.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPThrottlingRule.md index 5592e68ba..5f83148ed 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPThrottlingRule.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPThrottlingRule.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes properties of an existing throttling rule. - ## SYNTAX ``` @@ -26,10 +25,9 @@ Use the `Set-SPThrottlingRule` cmdlet to change the properties of an existing th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE--------------------- +### EXAMPLE ```powershell $web=Get-SPWebApplication -Identity $rm=Get-SPRequestManagementSettings -Identity $web @@ -41,17 +39,18 @@ Set-SPThrottlingRule -Identity $ throttlingrule -Criteria $criteriaNew -Threshol This example sets throttling rule property - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the throttling rule object to set. ```yaml Type: SPThrottlingRulePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +74,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -Criteria + +> Applicable: SharePoint Server Subscription Edition + Specifies the criteria for the rule to match. ```yaml Type: SPRequestManagementRuleCriteriaPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -Expiration + +> Applicable: SharePoint Server Subscription Edition + Specifies the expiration date and time of the rule. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,14 +120,16 @@ Accept wildcard characters: False ``` ### -Threshold + +> Applicable: SharePoint Server Subscription Edition + Specifies a value between 0 and 10 which defines the maximum threshold for throttling. The Request Manager will remove routing targets if the Health-Score becomes greater than this value. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTimerJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTimerJob.md index 27a451587..aa7bd6f8b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTimerJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTimerJob.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the schedule for running a timer job. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Set-SPTimerJob` cmdlet sets the schedule for running a specified timer job. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE------------------------ +### EXAMPLE ```powershell Get-SPTimerJob job-recycle-bin-cleanup | Set-SPTimerJob -Schedule "weekly at sat 5:00" ``` @@ -38,6 +36,9 @@ This example sets the schedule to run the job-recylce-bin-cleanup timer job to w ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the timer job to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -45,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -Schedule + +> Applicable: SharePoint Server Subscription Edition + Specifies the schedule for running the timer job. The type must be a valid SharePoint Timer service (SPTimer) schedule in the form of any one of the following schedules: @@ -109,8 +116,7 @@ The type must be a valid SharePoint Timer service (SPTimer) schedule in the form ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +126,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -127,7 +136,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplication.md index e2f6bdd7b..cbbf6c4f7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the properties on the topology service application of the local farm. - ## SYNTAX ``` @@ -26,10 +25,9 @@ The `Set-SPTopologyServiceApplication` cmdlet sets the advanced properties of an For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPTopologyServiceApplication 67877d63-bff4-4521-867a-ef4979ba07ce -LoadBalancedURL "https://testurl" ``` @@ -39,10 +37,12 @@ This example sets the load-balanced URL for the topology service application. The topology service application GUID is unique to every farm. You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the application to be set. The type must be a valid GUID, in the form 1234-456-854gh. @@ -50,8 +50,7 @@ The type must be a valid GUID, in the form 1234-456-854gh. ```yaml Type: SPTopologyWebServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +60,9 @@ Accept wildcard characters: False ``` ### -LoadBalancerUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies an external physical load balancer. The type must be a valid URL, in the form http://search. @@ -68,8 +70,7 @@ The type must be a valid URL, in the form http://search. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -108,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -125,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplicationProxy.md index 8a6bacc83..8af3bb961 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTopologyServiceApplicationProxy.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the proxy properties of the topology service application. - ## SYNTAX ``` @@ -25,10 +24,9 @@ The `Set-SPTopologyServiceApplicationProxy` cmdlet sets the properties of the lo For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPTopologyServiceApplicationProxy 67877d63-bff4-4521-867a-ef4979ba07ce -BadListPeriod 1234 ``` @@ -38,10 +36,12 @@ This example sets the bad list period for the given topology service application The topology service application GUID is unique to every farm. You can run the `Get-SPTopologyServiceApplication` cmdlet to retrieve the GUID. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the application proxy. The type must be a valid GUID, in the form 1234-4567-098jhj. @@ -49,8 +49,7 @@ The type must be a valid GUID, in the form 1234-4567-098jhj. ```yaml Type: SPTopologyWebServiceProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -60,6 +59,9 @@ Accept wildcard characters: False ``` ### -BadListPeriod + +> Applicable: SharePoint Server Subscription Edition + Specifies the time period that a node is kept in a bad list. The type must be a valid value between 1 and 480 (in minutes). @@ -69,8 +71,7 @@ The default value is 10. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -80,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -91,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +115,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -119,6 +124,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -126,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplication.md index 2a6557ca3..fc0b8be11 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplication.md @@ -37,17 +37,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ```powershell Set-SPTranslationServiceApplication TranslationService -JobExpirationDays 14 -TotalActiveProcesses 3 ``` This example sets the job expiration to 14 days and the number of worker processes per server to 3 for the Machine Translation Service application named TranslationService. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the instance of the Machine Translation service to set. The type must be a valid URL in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). @@ -55,8 +57,7 @@ The type must be a valid URL in the form, https://server_name or a valid GUID (f ```yaml Type: TranslationServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +67,9 @@ Accept wildcard characters: False ``` ### -AddEnabledFileExtensions + +> Applicable: SharePoint Server Subscription Edition + Comma delimited list of file extensions that you want to add to the set of enabled file extensions for the Machine Translation Service application To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). @@ -73,8 +77,7 @@ To return a list of supported file extensions, type \[Microsoft.Office.Translati ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the managed application pool that the instance of Translation Service will run in. ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -111,8 +119,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,13 +129,15 @@ Accept wildcard characters: False ``` ### -ClearEnabledFileExtensions + +> Applicable: SharePoint Server Subscription Edition + Disables all file extensions for the Machine Translation Service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -155,14 +166,16 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,13 +185,15 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the database name which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,13 +203,15 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the database server which is to be used for this Translation Service instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,13 +221,15 @@ Accept wildcard characters: False ``` ### -DisableBinaryFileScan + +> Applicable: SharePoint Server Subscription Edition + Determines whether Gatekeeper is run on binary files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -220,13 +239,15 @@ Accept wildcard characters: False ``` ### -EnableAllFileExtensions + +> Applicable: SharePoint Server Subscription Edition + Enables all file extensions for the Machine Translation Service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -236,13 +257,15 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -252,13 +275,15 @@ Accept wildcard characters: False ``` ### -JobExpirationDays + +> Applicable: SharePoint Server Subscription Edition + Specifies the amount of days after which completed jobs can be automatically removed from the Machine Translation Service queue database. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -268,6 +293,9 @@ Accept wildcard characters: False ``` ### -KeepAliveTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the length of time (in seconds) that the worker can be inactive before it is automatically stopped. The valid values are 60 to 600. @@ -276,8 +304,7 @@ The default value is 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -287,14 +314,16 @@ Accept wildcard characters: False ``` ### -MachineTranslationAddress + +> Applicable: SharePoint Server Subscription Edition + Specifies the service URL the service application will use to call the translation provider. For example, https://api.microsofttranslator.com/v2/soap.svc ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -304,13 +333,15 @@ Accept wildcard characters: False ``` ### -MachineTranslationCategory + +> Applicable: SharePoint Server Subscription Edition + Specifies the category which will be used by the service when calling the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -320,13 +351,15 @@ Accept wildcard characters: False ``` ### -MachineTranslationClientId + +> Applicable: SharePoint Server Subscription Edition + Specifies the AppId which will be used by the service when calling the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -336,6 +369,9 @@ Accept wildcard characters: False ``` ### -MaximumBinaryFileSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain binary data. The valid values are 100 to 524288. The default value is 51200. @@ -343,8 +379,7 @@ The default value is 51200. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -354,6 +389,9 @@ Accept wildcard characters: False ``` ### -MaximumItemsPerDay + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of items which can be added to the job queue in a 24-hour period. A value of zero indicates no limit. @@ -364,8 +402,7 @@ The default value is zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -375,6 +412,9 @@ Accept wildcard characters: False ``` ### -MaximumItemsPerPartitionPerDay + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of items which can be added to the job queue in a 24-hour period per partition. A value of zero indicates no limit. @@ -385,8 +425,7 @@ The default value is zero. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -396,6 +435,9 @@ Accept wildcard characters: False ``` ### -MaximumSyncTranslationRequests + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of items which can be added to the sync queue. A valid of zero indicates no limit. @@ -405,8 +447,7 @@ The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -416,6 +457,9 @@ Accept wildcard characters: False ``` ### -MaximumTextFileSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain mostly text data. The valid values are 100 to 15360. The default value is 5120. @@ -423,8 +467,7 @@ The default value is 5120. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -434,6 +477,9 @@ Accept wildcard characters: False ``` ### -MaximumTranslationAttempts + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum number of attempts an unsuccessful job is tried before it is marked as Failed. The valid values are 1 to 10. @@ -442,8 +488,7 @@ The default value is 2. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -453,6 +498,9 @@ Accept wildcard characters: False ``` ### -MaximumTranslationTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum length of time (in minutes) that a translation can take. The valid values are 60 to 3600. @@ -461,8 +509,7 @@ The default value is 600. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -472,6 +519,9 @@ Accept wildcard characters: False ``` ### -MaximumWordCharacterCount + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum character count for a Microsoft Word document which can be translated. The valid Int values are 10000 to 10000000. @@ -480,8 +530,7 @@ The default value is 500000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -491,6 +540,9 @@ Accept wildcard characters: False ``` ### -RecycleProcessThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of documents which are translated before a Translation Worker process is recycled. The valid values are 1 to 1,000. @@ -499,8 +551,7 @@ The default value is 100. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -510,6 +561,9 @@ Accept wildcard characters: False ``` ### -RemoveEnabledFileExtensions + +> Applicable: SharePoint Server Subscription Edition + Comma delimited list of file extensions that you want to remove from the set of enabled file extensions for the Machine Translation Service application. To return a list of supported file extensions, type \[Microsoft.Office.TranslationServices.TranslationService\]::EnumerateFileExtensions(). @@ -517,8 +571,7 @@ To return a list of supported file extensions, type \[Microsoft.Office.Translati ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -528,6 +581,9 @@ Accept wildcard characters: False ``` ### -TimerJobFrequency + +> Applicable: SharePoint Server Subscription Edition + Specifies the frequency (in minutes) with which the timer job for this service application runs. The valid values are 1 to 59. The default value is 15 minutes. @@ -535,8 +591,7 @@ The default value is 15 minutes. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -546,6 +601,9 @@ Accept wildcard characters: False ``` ### -TotalActiveProcesses + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of Translation Workers which are simultaneously running on a single machine. The valid values are 1 to 5. @@ -554,8 +612,7 @@ The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -565,6 +622,9 @@ Accept wildcard characters: False ``` ### -TranslationsPerInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of translations dispatched to each service instance every time the timer job is run. Valid values are 1 to 1,000. @@ -573,8 +633,7 @@ The default value is 200. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -584,13 +643,15 @@ Accept wildcard characters: False ``` ### -UseDefaultInternetSettings + +> Applicable: SharePoint Server Subscription Edition + Determines whether the service application will use default Internet settings for the user service account to connect to the translation provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -600,13 +661,15 @@ Accept wildcard characters: False ``` ### -WebProxyAddress + +> Applicable: SharePoint Server Subscription Edition + Specifies the web proxy address and port that the service application will use to connect to the translation provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -616,6 +679,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -623,7 +689,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplicationProxy.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplicationProxy.md index 63e7a6021..d03c1efb4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplicationProxy.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationServiceApplicationProxy.md @@ -25,7 +25,7 @@ Use the `Set-SPTranslationServiceApplicationProxy` cmdlet to set properties on a ## EXAMPLES -### -------------EXAMPLE--------- +### EXAMPLE ```powershell Set-SPTranslationServiceApplicationProxy TranslationServiceProxy -DefaultProxyGroup ``` @@ -35,6 +35,9 @@ This example adds the Machine Translation Service application proxy named Transl ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application proxy. The type must be a valid GUID in the form, 12345678-90ab-cdef-1234-567890bcdefgh. @@ -42,8 +45,7 @@ The type must be a valid GUID in the form, 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: TranslationServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -53,6 +55,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -64,8 +69,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -75,6 +79,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -82,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -92,13 +98,15 @@ Accept wildcard characters: False ``` ### -DefaultProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Machine Translation Service application proxy be added to the default proxy group for the local farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -108,6 +116,9 @@ Accept wildcard characters: False ``` ### -MaximumGroupSize + +> Applicable: SharePoint Server Subscription Edition + Maximum number of bytes the proxy will send to the service in a single request. The valid values are 131072 to 10485760. The default value is 2097152. @@ -117,8 +128,7 @@ We do not recommend use of this parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -128,6 +138,9 @@ Accept wildcard characters: False ``` ### -MaximumItemCount + +> Applicable: SharePoint Server Subscription Edition + Maximum number of documents to be translated that the proxy will send to the service in a single request. The valid values are 1 to 40960. The default value is 9000. @@ -137,8 +150,7 @@ We do not recommend use of this parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -155,7 +170,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationThrottlingSetting.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationThrottlingSetting.md index f7e6b7a8f..2653a0094 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationThrottlingSetting.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTranslationThrottlingSetting.md @@ -24,7 +24,7 @@ Use the Set-SPTranslationThrottlingSetting cmdlet to set the timer job duration ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ```powershell Set-SPTranslationThrottlingSetting -SiteQuota 300 -TenantQuota 600 ``` @@ -33,19 +33,20 @@ This limits the Translation Timer job to spend no more than 300 seconds (5 minut Note: TenantQuota must be greater than or equal to SiteQuota. - ## PARAMETERS ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server Subscription Edition + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**NOTE:** When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -55,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,13 +75,14 @@ Accept wildcard characters: False ### -SiteQuota +> Applicable: SharePoint Server Subscription Edition + The duration (in seconds) of timer job processing time that an individual SPSite is limited to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -88,13 +92,15 @@ Accept wildcard characters: False ``` ### -TenantQuota -The duration (in seconds) of timer job processing time that an individual tenant is limited to. + +> Applicable: SharePoint Server Subscription Edition + +The duration (in seconds) of timer job processing time that an individual tenant is limited to. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -111,7 +120,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedIdentityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedIdentityTokenIssuer.md index e4bb2be3d..18f98a2bf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedIdentityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedIdentityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the identity providers of a Web application. - ## SYNTAX ### ImportCertificateParameterSet @@ -41,15 +40,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Set-SPTrustedIdentityTokenIssuer "LiveIDSTS" -Certificate (Get-ChildItem"cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") ``` This example sets the identity provider to LiveIDSTS. - -### -------------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell $ip = @( (Get-SPTrustedIdentityTokenIssuer "LiveID STS"), (New-SPTrustedIdentityTokenIssuer -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"), (Get-SPTrustedIdentityTokenIssuer "NTLM")) ) New-SPWebApplication https://contoso.com -IdentityProvider $ip @@ -58,7 +56,7 @@ New-SPWebApplication https://contoso.com -IdentityProvider $ip This example sets the identity provider using the .ASPNetMembership and Role parameters. When these parameters are used, a variable must be set; otherwise, the values do not take effect. -### -------------------------EXAMPLE 3---------------------- +### EXAMPLE 3 ```powershell $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2('C:\MyCert.cer') Set-SPTrustedIdentityTokenIssuer "LiveIDSTS" -ImportTrustCertificate $cert @@ -69,6 +67,9 @@ This example updates the certificate used by the identity provider. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity provider to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object. @@ -76,8 +77,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -87,6 +87,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +101,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,6 +111,9 @@ Accept wildcard characters: False ``` ### -ClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Specifies the IP STS that can resolve and search claims for claims people picker. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim provider (for example, MyIDprovider1); or an instance of a valid SPClaimProvider object. @@ -116,8 +121,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimProviderPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,6 +131,9 @@ Accept wildcard characters: False ``` ### -ClaimsMappings + +> Applicable: SharePoint Server Subscription Edition + Specifies the mapping of the claims from the original token to the SharePoint token. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object. @@ -134,8 +141,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPClaimMappingPipeBind[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -145,6 +151,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies a description for the new identity provider. The type must be a valid string; for example, LiveID STS. @@ -152,8 +161,7 @@ The type must be a valid string; for example, LiveID STS. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -163,6 +171,9 @@ Accept wildcard characters: False ``` ### -ImportTrustCertificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -170,8 +181,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -181,13 +191,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the Uri of the metadata endpoint. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -197,6 +209,9 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: SharePoint Server Subscription Edition + Specifies the realm, or resource partition, associated with this trust. The type must be a name of a valid realm; for example, MD_REALM. @@ -204,8 +219,7 @@ The type must be a name of a valid realm; for example, MD_REALM. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -215,6 +229,9 @@ Accept wildcard characters: False ``` ### -SignInUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign-in URLs for this trusted identity provider STS. The type must be a valid URL, in the form https://int.live.com/. @@ -222,8 +239,7 @@ The type must be a valid URL, in the form https://int.live.com/. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -233,14 +249,16 @@ Accept wildcard characters: False ``` ### -UseWReply + +> Applicable: SharePoint Server Subscription Edition + Includes a WReply with the token request. Wreply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -250,13 +268,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -266,13 +286,15 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the registered name of the token issuer, typically a URI, for example: "https://sts.windows.net/yourTenantId/" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -282,13 +304,15 @@ Accept wildcard characters: False ``` ### -UseStateToRedirect + +> Applicable: SharePoint Server Subscription Edition + Specifies whether or not to use the URI within the "state" property of client authentication requests to determine the proper page to redirect the client to after authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -298,6 +322,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -305,7 +332,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedRootAuthority.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedRootAuthority.md index 1003d18eb..bcbcba5d0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedRootAuthority.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedRootAuthority.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Creates a new trusted root authority. - ## SYNTAX ### ManualUpdateCertificateParameterSet @@ -35,10 +34,9 @@ If a certificate file is used, the certificate must be an X509 certificate witho For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 $cert.Import('C:\LiveIDSigningCert.pfx') @@ -47,10 +45,12 @@ Get-SPTrustedRootAuthority -Name "WFEFarm1" | Set-SPTrustedRootAuthority -Certif This example updates the certificate of the trusted root authority WFEFarm1. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted root authority to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -58,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedRootAuthorityPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +82,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,6 +92,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate of the trusted root authority. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -98,8 +102,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ManualUpdateCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -125,13 +130,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + {{Fill MetadataEndPoint Description}} ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -148,7 +158,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedSecurityTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedSecurityTokenIssuer.md index e7ab71571..65c5a41eb 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedSecurityTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedSecurityTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the trusted token issuer. - ## SYNTAX ### ImportCertificateParameterSet @@ -38,10 +37,9 @@ Use the `Set-SPTrustedSecurityTokenIssuer` cmdlet to set the trusted token issue For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ```powershell $a=Get-SPTrustedSecurityTokenIssuer Set-SPTrustedSecurityTokenIssuer -Identity $a -MetadataEndpoint https:///_layouts/15/metadata/json/1/ @@ -49,17 +47,18 @@ Set-SPTrustedSecurityTokenIssuer -Identity $a -MetadataEndpoint https:// Applicable: SharePoint Server Subscription Edition + Specifies the id of the SPTrustedSecurityTokenIssuer object to be set. ```yaml Type: SPTrustedSecurityTokenServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -80,8 +82,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,13 +92,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X509Certificate object that represents the public key of the signing certificate of the security token issuer. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,13 +129,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description of the issuer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -IsTrustBroker + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the trust is established with a self-issuer partner app (that is, Exchange Server or Lync). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -156,13 +165,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + Specifies the URI for the metadata endpoint of the issuer. ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -172,11 +183,13 @@ Accept wildcard characters: False ``` ### -RegisteredIssuerName + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -186,6 +199,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -193,7 +209,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedServiceTokenIssuer.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedServiceTokenIssuer.md index 1dccd6752..4de8998cf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedServiceTokenIssuer.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPTrustedServiceTokenIssuer.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates a trust with the farm. - ## SYNTAX ### ImportCertificateParameterSet @@ -35,10 +34,9 @@ If a certificate file is used, it must have only one X509 certificate without pr For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" - ImportTrustCertificate $cert @@ -46,18 +44,19 @@ Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" - ImportTr This example updates a SharePoint Farm trust using the trust certificate from a file. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Set-SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml" ``` This example updates a SharePoint farm trust using the trust certificate from the federation metadata endpoint URL. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the trusted service token issuer to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. @@ -65,8 +64,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTrustedServiceTokenIssuerPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -76,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +88,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +98,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the X.509 certificate object from trusted authentication provider farm. The type must be a name of a valid X.509 certificate; for example, Certificate1. @@ -105,8 +108,7 @@ The type must be a name of a valid X.509 certificate; for example, Certificate1. ```yaml Type: X509Certificate2 Parameter Sets: ImportCertificateParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +118,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies a description for the trust. The type must be a valid string; for example, WFE Farm Trust1. @@ -123,8 +128,7 @@ The type must be a valid string; for example, WFE Farm Trust1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,13 +138,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -150,13 +156,15 @@ Accept wildcard characters: False ``` ### -MetadataEndPoint + +> Applicable: SharePoint Server Subscription Edition + {{Fill MetadataEndPoint Description}} ```yaml Type: Uri Parameter Sets: MetadataEndPointParameterSet -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -173,7 +184,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageApplication.md index 086482d55..cb03d88f4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets properties of a usage application. - ## SYNTAX ``` @@ -27,20 +26,21 @@ The `Set-SPUsageApplication` cmdlet sets properties of a usage application. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE---------------------- +### EXAMPLE ```powershell Set-SPUsageApplication -Identity "Usage and Health data collection" -DatabaseServer "Server Name" -DatabaseName "New Logging DB" ``` This example changes the database server and database name used by the usage logging service to store logging data. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a usage application (for example; UsageApp1); or an instance of a valid SPServiceApplication object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the logging database. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. @@ -107,8 +113,7 @@ If the logging database does not exist, a logging database will be automatically ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +123,9 @@ Accept wildcard characters: False ``` ### -DatabasePassword + +> Applicable: SharePoint Server Subscription Edition + Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -126,8 +134,7 @@ The type must be a valid password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name; for example, SQLServerHost1. @@ -144,8 +154,7 @@ The type must be a valid SQL Server host name; for example, SQLServerHost1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -155,6 +164,9 @@ Accept wildcard characters: False ``` ### -DatabaseUsername + +> Applicable: SharePoint Server Subscription Edition + Specifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database. @@ -163,8 +175,7 @@ The type must be a valid user name; for example, UserName1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -174,13 +185,15 @@ Accept wildcard characters: False ``` ### -EnableLogging + +> Applicable: SharePoint Server Subscription Edition + Specifies that this usage application collects usage data. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -190,11 +203,13 @@ Accept wildcard characters: False ``` ### -FailoverDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -204,6 +219,9 @@ Accept wildcard characters: False ``` ### -UsageService + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPUsageService object that is the parent of the usage application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. @@ -211,8 +229,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -222,6 +239,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -229,7 +249,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageDefinition.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageDefinition.md index 81cf5b263..becaa0f29 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageDefinition.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageDefinition.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the retention period for a usage provider. - ## SYNTAX ``` @@ -27,20 +26,21 @@ A usage definition object defines a specific type of usage provider. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE-------------------- +### EXAMPLE ```powershell Set-SPUsageDefinition -Identity "Page Requests" -DaysRetained 31 ``` This example sets the number of days that stores page requests usage data to 31. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage definition object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object. @@ -48,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPUsageDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -DaysRetained + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days that usage data for the usage provider is retained in the usage service database. The default value is 14. @@ -106,8 +112,7 @@ The type must be an integer between 0 and 31. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,14 +122,16 @@ Accept wildcard characters: False ``` ### -DaysToKeepUsageFiles + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of days to keep usage file retention. The value must be less than or equal to value of the DaysRetained parameter. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + Turns on the specified usage provider. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -MaxTotalSizeInBytes + +> Applicable: SharePoint Server Subscription Edition + This parameter stores the maximum SQL storage size for the data of this provider. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,6 +177,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -173,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -183,13 +196,15 @@ Accept wildcard characters: False ``` ### -UsageDatabaseEnabled + +> Applicable: SharePoint Server Subscription Edition + Set to export usage data from the local server to the Usage database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageService.md index 3ec2d0f2a..9e6a3a597 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUsageService.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the properties of a usage service. - ## SYNTAX ``` @@ -27,10 +26,9 @@ If the Identity parameter is not specified, the cmdlet applies the changes to th For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------------EXAMPLE----------------- +### EXAMPLE ```powershell Set-SPUsageService -LoggingEnabled $false Set-SPUsageService -UsageLogLocation "D:\\testusagelogdir" @@ -39,10 +37,12 @@ Set-SPUsageService -UsageLogCutTime 5 The examples disables usage logging, changes the directory where usage files are stored and creates a new usage log file every 5 minutes. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the usage service to update. The type must be in one of the following forms: @@ -54,8 +54,7 @@ The type must be in one of the following forms: ```yaml Type: SPUsageServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -65,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -87,6 +88,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -94,7 +98,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -104,13 +107,15 @@ Accept wildcard characters: False ``` ### -LoggingEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that usage data is logged to usage files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,6 +125,9 @@ Accept wildcard characters: False ``` ### -UsageLogCutTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the time, in minutes, of usage data that is collected per usage log file. The default time is 5 minutes. @@ -128,8 +136,7 @@ The value must be an integer in the range of 1 to 1440. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -UsageLogLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the path on every computer in the farm where usage log files are created. The value must be a valid local path in the following form: @@ -148,8 +158,7 @@ The value must be a valid local path in the following form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,6 +168,9 @@ Accept wildcard characters: False ``` ### -UsageLogMaxFileSizeKB + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum size of a single usage file that is applied to all the usage providers. The minimum value is 512 kilobytes (KB) and the maximum value is 65536 KB. @@ -166,8 +178,7 @@ The minimum value is 512 kilobytes (KB) and the maximum value is 65536 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -177,14 +188,16 @@ Accept wildcard characters: False ``` ### -UsageLogMaxSpaceGB + +> Applicable: SharePoint Server Subscription Edition + The maximum amount of space (measured in gigabytes) allowed for usage logs. Althought the parameter is present in later SharePoint Server versions, it is applicable only to SharePoint Server 2010. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,6 +207,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -201,7 +217,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUser.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUser.md index eea4d9b80..0694d0e40 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUser.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPUser.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures properties of an existing user. - ## SYNTAX ``` @@ -27,18 +26,16 @@ The `Set-SPUser` cmdlet configures properties of an existing user. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -AddPermissionLevel "Contributor" ``` This example sets a user (Contoso\jdoe) to be a contributor on https://intranet.contoso.com. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Set-SPUser -Identity 'Contoso\jdoe' -Web https://intranet.contoso.com -SyncFromAD ``` @@ -48,6 +45,9 @@ This updates the User Information List for the user 'contoso\jdoe' with the curr ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID, login name, or SPUser object of the user to be returned. The type must be a GUID of an existing user in the form, 1234-5678-9876-0987. @@ -56,7 +56,6 @@ The type must be a GUID of an existing user in the form, 1234-5678-9876-0987. Type: SPUserPipeBind Parameter Sets: (All) Aliases: UserAlias -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -AddPermissionLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the permission level to add to the user. The value must be one of the following options: @@ -93,8 +95,7 @@ Can view pages and list items and download documents. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +105,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -115,8 +119,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -126,14 +129,16 @@ Accept wildcard characters: False ``` ### -ClearPermissions + +> Applicable: SharePoint Server Subscription Edition + Deletes all assigned permissions from the user. If Clear and Add values exist, permissions are first cleared and then new permissions are added. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -143,6 +148,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -150,7 +158,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: SharePoint Server Subscription Edition + Specifies the new display name of the user. The type must be a valid name. @@ -167,8 +177,7 @@ The type must be a valid name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,13 +187,15 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server Subscription Edition + Specifies the new email address of the user. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,13 +205,15 @@ Accept wildcard characters: False ``` ### -Group + +> Applicable: SharePoint Server Subscription Edition + Adds the user to an existing group in the given site. ```yaml Type: SPGroupPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -IsSiteCollectionAdmin + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to set the user as a site collection administrator. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -226,14 +241,16 @@ Accept wildcard characters: False ``` ### -PassThru -If not provided, indicates that this cmdlet has no output. + +> Applicable: SharePoint Server Subscription Edition + +If not provided, indicates that this cmdlet has no output. If provided, this parameter indicates that the SPUser object for this user is to be returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -243,13 +260,15 @@ Accept wildcard characters: False ``` ### -RemovePermissionLevel + +> Applicable: SharePoint Server Subscription Edition + Removes the permission level from the user. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -259,13 +278,15 @@ Accept wildcard characters: False ``` ### -SyncFromAD + +> Applicable: SharePoint Server Subscription Edition + If provided, specifies that user information will be synchronized from the user directory store. This switch only retrieves the `displayName` and `mail` value from the directory store. It supports Active Directory (Classic or Windows authentication), Forms-based Authentication, and SAML. FBA and SAML providers must support resolving from their directory store for this switch to work. The switch only supports SharePoint User objects. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -275,6 +296,9 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the URL or GUID to be used as a scope. This parameter is not needed if the SPUser object is provided as the identity. @@ -283,8 +307,7 @@ The value must be an authentic URL, in the form https://server_name, or GUID, in ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -294,6 +317,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -301,7 +327,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioExternalData.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioExternalData.md index f115b3680..88894cc21 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioExternalData.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioExternalData.md @@ -27,17 +27,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPVisioExternalData -VisioServiceApplication "VGS1" -UnattendedServiceAccountApplicationID "SSSApp1" ``` This example sets the unattended service account application ID to SSSApp1 for the Visio Services application named VGS1. - ## PARAMETERS ### -UnattendedServiceAccountApplicationID + +> Applicable: SharePoint Server Subscription Edition + Specifies the target application ID in the registered secure store service that is used to reference unattended service account credentials. The unattended service account is a single account that all documents can use to refresh data. It is required when connecting to external data sources. @@ -48,8 +50,7 @@ The application ID must be registered in the secure store service application or ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioExternalData object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -66,8 +70,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioPerformance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioPerformance.md index bebb31e56..9a1377439 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioPerformance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioPerformance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets performance properties for a Visio Services application. - ## SYNTAX ``` @@ -26,18 +25,16 @@ The `Set-SPVisioPerformance` cmdlet sets properties related to performance for a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 -MaxRecalcDuration 120 -MinDiagramCacheAge 1 -MaxDiagramCacheAge 4 ``` This example changes settings that are related to performance for a Visio Services application. - -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Set-SPVisioPerformance -VisioServiceApplication "VGS2" -MaxDiagramSize 10 ``` @@ -46,10 +43,12 @@ This example changes settings that are related to performance for a Visio Servic Note that only one setting value is specified. The cmdlet prompts you for the other parameter values. - ## PARAMETERS ### -MaxDiagramCacheAge + +> Applicable: SharePoint Server Subscription Edition + Specifies the time, in minutes, after which cached items are purged. This value affects memory use on the server. A large cache age slows the rate at which diagrams can be refreshed by users and reduces CPU and memory use of the server. @@ -60,8 +59,7 @@ The type must be an integer in the range of 0 to 34560 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,6 +69,9 @@ Accept wildcard characters: False ``` ### -MaxDiagramSize + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum size, in megabytes, of a diagram that can be opened by the Visio Services application. The default value is 5. @@ -79,8 +80,7 @@ The type must be an integer in the range of 1 to 50. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -90,6 +90,9 @@ Accept wildcard characters: False ``` ### -MaxRecalcDuration + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum time, in seconds, that a diagram can only be recalculated by the Visio Services application. Diagram recalculation operations that take longer than this number of seconds are canceled by the service. A low value increases performance by allowing only simple diagrams to be processed by the server, which minimizes CPU and memory use. @@ -101,8 +104,7 @@ The default value is 60 seconds. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -112,6 +114,9 @@ Accept wildcard characters: False ``` ### -MinDiagramCacheAge + +> Applicable: SharePoint Server Subscription Edition + Specifies the minimum time, in minutes, a diagram is cached in memory. This value affects memory use on the server. A small value allows users to refresh their diagrams more often, but will increase memory and CPU load of the server. @@ -122,8 +127,7 @@ The type must be an integer in the range of 0 to 34560 (24 days). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -133,6 +137,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioPerformance object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -140,8 +147,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -151,6 +157,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -162,8 +171,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -173,13 +181,15 @@ Accept wildcard characters: False ``` ### -MaxCacheSize + +> Applicable: SharePoint Server Subscription Edition + {{Fill MaxCacheSize Description}} ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioSafeDataProvider.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioSafeDataProvider.md index c1d7a3af5..960f72e1a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioSafeDataProvider.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioSafeDataProvider.md @@ -25,18 +25,16 @@ The `Set-SPVisioSafeDataProvider` cmdlet sets the Description property of a safe For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Set-SPVisioSafeDataProvider -VisioServiceApplication "VGS1" -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" ``` This example sets the description property of a safe data provider for a specific Visio Services application. - -### -------------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPVisioServiceApplication -Identity "VGS1" | Set-SPVisioSafeDataProvider -DataProviderID "SQLOLEDB" -DataProviderType 1 -Description "SQL OLEDB Driver!" ``` @@ -44,10 +42,12 @@ Get-SPVisioServiceApplication -Identity "VGS1" | Set-SPVisioSafeDataProvider -Da This example sets the Description property of a safe data provider for a specific Visio Services application. The result is piped from the `Set-SPVisioSafeDataProvider` cmdlet. - ## PARAMETERS ### -DataProviderId + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the data provider to update. The combination of DataProviderID and DataProviderType uniquely identifies a data provider for a Visio Services application. The string that identifies the data provider can be a maximum of 255 alphanumeric characters. @@ -58,8 +58,7 @@ The type must be a valid string that identifies the data provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -DataProviderType + +> Applicable: SharePoint Server Subscription Edition + Specifies the supported type of the data provider to get. Custom data types are supported; for example, Excel services. @@ -77,8 +79,7 @@ The type must be a valid identity of a data provider type. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the description of the safe data provider to set. The type must be a string with a maximum of 4096 characters. @@ -95,8 +99,7 @@ The type must be a string with a maximum of 4096 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -106,6 +109,9 @@ Accept wildcard characters: False ``` ### -VisioServiceApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application that contains the SPVisioSafeDataProvider object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -113,8 +119,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -135,8 +143,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioServiceApplication.md index 1f6be6f13..26e4dbc1c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPVisioServiceApplication.md @@ -25,18 +25,16 @@ The `Set-SPVisioServiceApplication` cmdlet sets the ServiceApplicationPool prope For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------------EXAMPLE 1---------------------- +### EXAMPLE 1 ```powershell Set-SPVisioServiceApplication -identity "VGS1" -ServiceApplicationPool "SharePoint Web Services System Default" ``` This example changes the application pool of the VGS1 service application. - -### -----------------EXAMPLE 2---------------------- +### EXAMPLE 2 ```powershell Get-SPServiceApplicationPool "SharePoint Web Services Default" | Set-SPVisioServiceApplication VGS1 ``` @@ -44,10 +42,12 @@ Get-SPServiceApplicationPool "SharePoint Web Services Default" | Set-SPVisioServ This example changes the application pool of the VGS1 service application. The results are piped from the `Get-SPServiceApplicationPool` cmdlet. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Visio Services application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Visio Services application (for example, MyVisioService1); or an instance of a valid SPVisioServiceApplication object. @@ -55,8 +55,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPVisioServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -66,6 +65,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the IIS application pool to change. The Web service for the service application runs in the specified application pool. @@ -74,8 +76,7 @@ The type must be a valid name of a Visio Service application pool, such as MyVis ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -85,6 +86,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -96,8 +100,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -114,7 +120,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +139,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIBinding.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIBinding.md index 297fd9fbc..7996b69cd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIBinding.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIBinding.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the default click action for an application or file name extension binding. - ## SYNTAX ``` @@ -27,10 +26,9 @@ To do this, you set the default action to true for the "view"-"Word" bindings. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPWOPIBinding -Action "view" -Application "Word"| Set-SPWOPIBinding -DefaultAction:$true ``` @@ -39,17 +37,18 @@ This example sets the default click action to view for a Word document in a Shar You can verify that the default click action is set to view for Word by running the cmdlet `Get-SPWOPIBinding -Action "view" -Application "Word"`. The IsDefaultAction value is set to "True." - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the binding. ```yaml Type: SPWopiBindingPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,13 +58,15 @@ Accept wildcard characters: False ``` ### -DefaultAction + +> Applicable: SharePoint Server Subscription Edition + Specifies whether the binding should be set as the default click action for an application or file name extension in the binding. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -86,8 +90,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -104,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -121,7 +129,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIZone.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIZone.md index d22e8e5e0..5bc515673 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIZone.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWOPIZone.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the zone that the current SharePoint farm will use to navigate the browser to the WOPI application. - ## SYNTAX ``` @@ -30,20 +29,21 @@ Only use HTTP when you are on a fully secure network that uses IPSEC (full encry For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Set-SPWOPIZone -Zone "external-https" ``` This example configures the current SharePoint farm to use external connections through HTTPS to the WOPI application (such as a server that runs Office Web Apps Server). - ## PARAMETERS ### -Zone + +> Applicable: SharePoint Server Subscription Edition + Specifies the zone. For a list of zones that the WOPI application supports, run `Get-SPWOPIBinding`. @@ -60,8 +60,7 @@ The options are as follows: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -71,6 +70,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -82,8 +84,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,6 +94,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -100,7 +104,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters`. @@ -117,7 +123,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWeb.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWeb.md index fd953b068..b6df8ecb9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWeb.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWeb.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the specified subsite. - ## SYNTAX ``` @@ -29,17 +28,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPWeb https://sitename/subweb | Set-SPWeb -Description "My Site Description" ``` This example sets the description of an existing subsite. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The URL of the Web or SPWeb object that represents the Web. The type must be a valid URL, in the form https://server_name, or an SPWeb object. @@ -47,8 +48,7 @@ The type must be a valid URL, in the form https://server_name, or an SPWeb obje ```yaml Type: SPWebPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,13 +58,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: SharePoint Server Subscription Edition + Specifies the new description of the Web. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -74,14 +76,16 @@ Accept wildcard characters: False ``` ### -RelativeUrl + +> Applicable: SharePoint Server Subscription Edition + Specifies the new relative URL for the Web. This is the URL path after the site collection URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -91,13 +95,15 @@ Accept wildcard characters: False ``` ### -Theme + +> Applicable: SharePoint Server Subscription Edition + Specifies the new theme to apply to the Web. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,14 +113,16 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: SharePoint Server Subscription Edition + Specifies the new template to apply to the Web. This cannot be done if the template is already applied. ```yaml Type: SPWebTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -124,6 +132,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -135,8 +146,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +156,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +166,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,6 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -170,7 +185,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplication.md index 8cf82b28f..342e4154b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the specified web application. - ## SYNTAX ### UpdateGeneralSettings (Default) @@ -82,13 +81,15 @@ This example sets the http://servername web application to use the SMTP server m ## PARAMETERS ### -AdditionalClaimProvider + +> Applicable: SharePoint Server Subscription Edition + Adds a specific claim provider to the defined web application. ```yaml Type: SPClaimProviderPipeBind[] Parameter Sets: UpdateClaimSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +99,9 @@ Accept wildcard characters: False ``` ### -AllowLegacyEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies that older SSL and TLS protocol versions and cipher suites are allowed to be used with this IIS website. Legacy encryption is weaker than modern encryption and is not recommended. @@ -110,7 +114,6 @@ This parameter is only valid when used with the SecureSocketsLayer parameter. Type: SwitchParameter Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -120,6 +123,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -131,8 +137,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -142,14 +147,16 @@ Accept wildcard characters: False ``` ### -AuthenticationMethod + +> Applicable: SharePoint Server Subscription Edition + Use to set a web application to classic Windows authentication. The valid values are NTLM or Kerberos. ```yaml Type: String Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -159,13 +166,15 @@ Accept wildcard characters: False ``` ### -AuthenticationProvider + +> Applicable: SharePoint Server Subscription Edition + Defines the authentication provider(s) that applies to the web application. ```yaml Type: SPAuthenticationProviderPipeBind[] Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,6 +184,9 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: SharePoint Server Subscription Edition + Specifies the certificate that will be used for the Secure Sockets Layer (SSL) binding of this IIS website, or for authenticating to an SMTP server to send email. When configuring the Secure Sockets Layer (SSL) binding of this IIS website, this parameter is only valid when used with the SecureSocketsLayer parameter. @@ -184,7 +196,6 @@ When configuring SMTP authentication, this parameter is only valid when the Disa Type: SPServerCertificatePipeBind Parameter Sets: UpdateIISSettings, UpdateMailSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -194,13 +205,15 @@ Accept wildcard characters: False ``` ### -DefaultQuotaTemplate + +> Applicable: SharePoint Server Subscription Edition + Specifies the new default site quota template for this web application. ```yaml Type: String Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -DefaultTimeZone + +> Applicable: SharePoint Server Subscription Edition + Specifies the default time zone for new site collections in this web application. ```yaml Type: Int32 Parameter Sets: UpdateGeneralSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -DisableSMTPEncryption + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to turn on or off SMTP Encryption. The default value is false. @@ -233,8 +251,7 @@ The default value is false. ```yaml Type: SwitchParameter Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -244,13 +261,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Suppresses confirmation messages involved in settings for a web application. ```yaml Type: SwitchParameter Parameter Sets: UpdateClaimSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -260,6 +279,9 @@ Accept wildcard characters: False ``` ### -HostHeader + +> Applicable: SharePoint Server Subscription Edition + Specifies the host header binding for this IIS website. A host header binding allows multiple IIS websites to share the same port number. Web requests sent to a shared port number are routed to the correct IIS website based on the value of the HTTP host header sent by the client. @@ -270,7 +292,6 @@ If no host header binding is specified, then all web requests sent to this port Type: String Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -280,6 +301,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or URL of the web application. The type must be a valid name, in the form WebApplication-1212, or URL, in the form https://example.contoso.com. @@ -287,8 +311,7 @@ The type must be a valid name, in the form WebApplication-1212, or URL, in the f ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -298,13 +321,15 @@ Accept wildcard characters: False ``` ### -NotProvisionGlobally + +> Applicable: SharePoint Server Subscription Edition + Only provisions the web application on the local server with the changes specified by this cmdlet. Web applications on other servers in the farm will not be provisioned with these changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -314,14 +339,16 @@ Accept wildcard characters: False ``` ### -OutgoingEmailAddress + +> Applicable: SharePoint Server Subscription Edition + Specifies the new outgoing e-mail address for e-mail messages sent from this web application. The type must be a valid address; for example, someone@example.com. ```yaml Type: String Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -331,6 +358,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: SharePoint Server Subscription Edition + Specifies the port on which this web application can be accessed. This can be any valid port number. @@ -340,7 +370,6 @@ If you specify a port number that has already been assigned, IIS does not start Type: Int32 Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -350,6 +379,9 @@ Accept wildcard characters: False ``` ### -ReplyToEmailAddress + +> Applicable: SharePoint Server Subscription Edition + Configures the reply e-mail address. The type must be a valid address; for example, someone@example.com. @@ -358,7 +390,6 @@ The type must be a valid address; for example, someone@example.com. Type: String Parameter Sets: UpdateMailSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -368,6 +399,9 @@ Accept wildcard characters: False ``` ### -SecureSocketsLayer + +> Applicable: SharePoint Server Subscription Edition + Enables Secure Sockets Layer (SSL) encryption for this web application. If you choose to use SSL, you must import a server certificate to SharePoint and assign it to the IIS website for this web application. Until this is done, the web application will be inaccessible from this IIS website. @@ -380,7 +414,6 @@ If this parameter is omitted or set to False, this web application will use HTTP Type: SwitchParameter Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -390,6 +423,9 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxyGroup + +> Applicable: SharePoint Server Subscription Edition + Specifies a custom service application proxy group for the web application to use. The web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the farm's default proxy group is used. @@ -398,7 +434,6 @@ If this parameter is not specified, the farm's default proxy group is used. Type: SPServiceApplicationProxyGroupPipeBind Parameter Sets: UpdateGeneralSettings Aliases: ProxyGroup -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -408,13 +443,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectProvider + +> Applicable: SharePoint Server Subscription Edition + Sets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider. ```yaml Type: SPTrustedIdentityTokenIssuerPipeBind Parameter Sets: UpdateClaimSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -424,13 +461,15 @@ Accept wildcard characters: False ``` ### -SignInRedirectURL + +> Applicable: SharePoint Server Subscription Edition + Specifies the sign-in redirect URL for the web application. ```yaml Type: String Parameter Sets: UpdateClaimSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -440,6 +479,9 @@ Accept wildcard characters: False ``` ### -SMTPCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies credentials to authenticate to the SMTP server. Set the value to $null to connect to the SMTP server anonymously. If this parameter isn't specified, the existing authentication settings will be preserved. @@ -450,7 +492,6 @@ You must use the `Set-SPApplicationCredentialKey` PowerShell cmdlet to set an id Type: PSCredential Parameter Sets: UpdateMailSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -460,14 +501,16 @@ Accept wildcard characters: False ``` ### -SMTPServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the new outbound SMTP server that this web application will use. Set to $null to clear the server setting. ```yaml Type: String Parameter Sets: UpdateMailSettings -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -492,13 +535,15 @@ Accept wildcard characters: False ``` ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the load-balanced URL for the web application zone. ```yaml Type: String Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -508,6 +553,9 @@ Accept wildcard characters: False ``` ### -UseServerNameIndication + +> Applicable: SharePoint Server Subscription Edition + Specifies that the Secure Sockets Layer (SSL) binding of this IIS website should use Server Name Indication (SNI). Server Name Indication allows multiple IIS websites with unique host headers and unique server certificates to share the same SSL port. If Server Name Indication isn't used, all IIS websites sharing the same SSL port must share the same SSL certificate. @@ -516,7 +564,6 @@ If Server Name Indication isn't used, all IIS websites sharing the same SSL port Type: SwitchParameter Parameter Sets: UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -526,6 +573,9 @@ Accept wildcard characters: False ``` ### -Zone + +> Applicable: SharePoint Server Subscription Edition + When configuring zone-specific settings, the zone to configure must be specified. This zone must already exist. @@ -535,7 +585,6 @@ The type must be any one of the following values: Default, Intranet, Internet, E Type: SPUrlZone Parameter Sets: UpdateClaimSettings, UpdateIISSettings Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -545,6 +594,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -552,7 +604,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -562,6 +613,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -569,7 +623,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplicationHttpThrottlingMonitor.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplicationHttpThrottlingMonitor.md index 538c52d75..b749b0230 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplicationHttpThrottlingMonitor.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWebApplicationHttpThrottlingMonitor.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $buckets=(2000,1000,500,300,200,100,50,30,20,10) Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint - @@ -38,8 +37,7 @@ Category Memory -Counter 'Available Mbytes' -IsDesc -HealthScoreBuckets $buckets This example sets the Health Score bucket values for the Memory\Available Mbytes counter to the array listed for the https://sharepoint Web application. - -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint 0 -Category Memory -Counter 'Available Mbytes' -IsDesc -UpperLimit 3000 @@ -47,10 +45,12 @@ Set-SPWebApplicationHttpThrottlingMonitor https://sharepoint This example sets the upper limit for the Memory\Available Mbytes counter, the highest value in the Health Score buckets, to 3000 for the https://sharepoint Web application. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -58,8 +58,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -69,6 +68,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the performance counter category. The type must be a valid performance counter category in the throttling monitor. @@ -77,8 +79,7 @@ Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of p ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 2 @@ -88,6 +89,9 @@ Accept wildcard characters: False ``` ### -Counter + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the performance counter. The type must be a valid performance counter in the throttling monitor. @@ -96,8 +100,7 @@ Use the `Get-SPWebApplicationHttpThrottlingMonitor` cmdlet to return a list of p ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 3 @@ -107,6 +110,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -118,8 +124,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -129,6 +134,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -136,7 +144,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -146,13 +153,15 @@ Accept wildcard characters: False ``` ### -HealthScoreBuckets + +> Applicable: SharePoint Server Subscription Edition + Specifies bucket ranges to use in determining the calculation of the server Health Score for this counter. ```yaml Type: Double[] Parameter Sets: (All) Aliases: Buckets -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: SharePoint Server Subscription Edition + Specifies the instance of the performance counter. The default value is empty. If the specified value is invalid, this cmdlet will not run. @@ -169,8 +181,7 @@ If the specified value is invalid, this cmdlet will not run. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -180,6 +191,9 @@ Accept wildcard characters: False ``` ### -IsDESC + +> Applicable: SharePoint Server Subscription Edition + Specifies that this counter is interpreted in descending order. If this parameter is set, Health Score bucket values are interpreted in descending order; for example, set this parameter by using the Memory category and Available Mbytes counter to monitor available memory. @@ -187,8 +201,7 @@ If this parameter is set, Health Score bucket values are interpreted in descendi ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -198,6 +211,9 @@ Accept wildcard characters: False ``` ### -LowerLimit + +> Applicable: SharePoint Server Subscription Edition + Specifies the lower limit of the numerical threshold of the specified performance counter. The lower limit is the lowest value in the Health Score bucket values. @@ -205,7 +221,6 @@ The lower limit is the lowest value in the Health Score bucket values. Type: Double Parameter Sets: (All) Aliases: Lower -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -215,6 +230,9 @@ Accept wildcard characters: False ``` ### -UpperLimit + +> Applicable: SharePoint Server Subscription Edition + Specifies the upper limit of the numerical threshold of the specified performance counter. The upper limit is the highest value in the Health Score bucket values. @@ -222,7 +240,6 @@ The upper limit is the highest value in the Health Score bucket values. Type: Double Parameter Sets: (All) Aliases: Upper -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -232,6 +249,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -239,7 +259,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWordConversionServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWordConversionServiceApplication.md index ac0d4cdd8..15cf43b51 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWordConversionServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWordConversionServiceApplication.md @@ -31,20 +31,21 @@ The `Set-SPWordConversionServiceApplication` cmdlet sets global properties of a For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -----------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPServiceApplication -Name WordServices1 | Set-SPWordConversionServiceApplication -TimerJobFrequency 30 ``` This example sets the timer job frequency of the WordServices1 application to 30 minutes. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Word Automation Services application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Word Automation Services application (for example, WordSvcApp1); or an instance of a valid SPServiceApplication object. @@ -52,8 +53,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: WordServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +63,9 @@ Accept wildcard characters: False ``` ### -ActiveProcesses + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of conversion processes on each machine on which the service application runs. This value is equivalent to the number of simultaneous conversions. The default value is 8. @@ -72,8 +75,7 @@ The type must be a valid integer in the range from 1 to 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -AddSupportedFormats + +> Applicable: SharePoint Server Subscription Edition + Specifies a set of file formats to be enabled for use by the service application. The value must be a comma-delimited list of one or more of the following: docx, doc, mht, rtf, xml. @@ -90,8 +95,7 @@ The value must be a comma-delimited list of one or more of the following: docx, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -ApplicationPool + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing IIS managed application pool in which this instance of Word Automation Services runs. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. @@ -108,8 +115,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPIisWebServiceApplicationPoolPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +125,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -130,8 +139,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,13 +149,15 @@ Accept wildcard characters: False ``` ### -ClearSupportedFormats + +> Applicable: SharePoint Server Subscription Edition + Specifies that all file formats should be disabled for use by the service application. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +167,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -164,7 +177,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -174,6 +186,9 @@ Accept wildcard characters: False ``` ### -ConversionsPerInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of items sent to each conversion process (see the ActiveProcesses parameter description earlier in this table) every time the timer job is run. The default value is 12. @@ -182,8 +197,7 @@ The type must be a valid integer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +207,9 @@ Accept wildcard characters: False ``` ### -ConversionTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the time, in minutes, after which a conversion that is marked InProgress is confirmed to be still running each time the timer job runs and if necessary, the conversion is restarted. The default value is 5. @@ -201,8 +218,7 @@ The type must be a valid integer in the range from 1 to 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -212,6 +228,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredential + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use for connecting to the database for the Word Automation Services application. Use this parameter only if SQL Authentication is used to access the service application database. @@ -220,8 +239,7 @@ When the DatabaseCredential parameter is specified, the DatabaseName and Databas ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -231,6 +249,9 @@ Accept wildcard characters: False ``` ### -DatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the database to use for this instance of the Word Automation Services application. The type must be a valid SQL database name; for example, MetadataDB1. @@ -238,8 +259,7 @@ The type must be a valid SQL database name; for example, MetadataDB1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -249,6 +269,9 @@ Accept wildcard characters: False ``` ### -DatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the host server for the Word Automation Services database. The type must be a valid SQL database server host name; for example, SQLServerHost1. @@ -256,8 +279,7 @@ The type must be a valid SQL database server host name; for example, SQLServerHo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -267,14 +289,16 @@ Accept wildcard characters: False ``` ### -DisableBinaryFileScan + +> Applicable: SharePoint Server Subscription Edition + Specifies whether additional checks are run when Word documents are processed. Turn this setting off only if all documents processed by the service are trusted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -284,13 +308,15 @@ Accept wildcard characters: False ``` ### -DisableEmbeddedFonts + +> Applicable: SharePoint Server Subscription Edition + Specifies whether embedded fonts are ignored when present in input documents. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -300,6 +326,9 @@ Accept wildcard characters: False ``` ### -KeepAliveTimeout + +> Applicable: SharePoint Server Subscription Edition + Specifies the length of time, in seconds, that a conversion can be non-responsive before it is terminated. The default value is 30. @@ -308,8 +337,7 @@ The type must be a valid integer in the range from 10 to 60. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -319,6 +347,9 @@ Accept wildcard characters: False ``` ### -MaximumConversionAttempts + +> Applicable: SharePoint Server Subscription Edition + The maximum number of conversion attempts before a conversion is marked with status "Failed". The default value is 2. @@ -327,8 +358,7 @@ The type must be a valid integer in the range from 1 to 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -338,6 +368,9 @@ Accept wildcard characters: False ``` ### -MaximumConversionTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum length of time, in seconds, that a conversion can run before it is terminated. The default value is 300. @@ -346,8 +379,7 @@ The type must be a valid integer in the range from 60 to MaxInt. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -357,6 +389,9 @@ Accept wildcard characters: False ``` ### -MaximumMemoryUsage + +> Applicable: SharePoint Server Subscription Edition + Specifies the maximum percentage of system memory which can be used by the service application. The default value is 100. @@ -365,8 +400,7 @@ The type must be a valid integer in the range from 10 to 100. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -376,6 +410,9 @@ Accept wildcard characters: False ``` ### -RecycleProcessThreshold + +> Applicable: SharePoint Server Subscription Edition + Specifies the number of documents which are converted before a conversion process is recycled. For additional information about the conversion process, see the ActiveProcess parameter description earlier in this table. @@ -384,8 +421,7 @@ The type must be a valid integer in the range from 1 to 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -395,6 +431,9 @@ Accept wildcard characters: False ``` ### -RemoveSupportedFormats + +> Applicable: SharePoint Server Subscription Edition + Specifies a set of file formats to be disabled for use by the service application. The value must be a comma delimited list of one or more of the following: docx, doc, mht, rtf, xml. @@ -402,8 +441,7 @@ The value must be a comma delimited list of one or more of the following: docx, ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -413,6 +451,9 @@ Accept wildcard characters: False ``` ### -TimerJobFrequency + +> Applicable: SharePoint Server Subscription Edition + Specifies the frequency, in minutes, with which the timer job for this service application runs. The default value is 15. @@ -421,8 +462,7 @@ The type must be a valid integer in the range from 1 to 59. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -432,6 +472,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -439,7 +482,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -449,13 +491,15 @@ Accept wildcard characters: False ``` ### -MaximumGroupSize + +> Applicable: SharePoint Server Subscription Edition + {{Fill MaximumGroupSize Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -465,13 +509,15 @@ Accept wildcard characters: False ``` ### -MaximumSyncConversionRequests + +> Applicable: SharePoint Server Subscription Edition + {{Fill MaximumSyncConversionRequests Description}} ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWorkflowConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWorkflowConfig.md index d3f9fd972..4760444fe 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWorkflowConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Set-SPWorkflowConfig.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Configures the workflow settings for the specified Web application. - ## SYNTAX ### SiteCollection @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Set-SPWorkflowConfig -webapplication https://sitename DeclarativeWorkflowsEnabled $true -EmailNoPermissionParticipantsEnabled $true -SendDocumentToExternalParticipants $false ``` @@ -52,10 +51,12 @@ No return values. Use the `Get-SPWorkflowConfig` cmdlet to see values. To set farm-level workflow settings for event-delivery time-out and to postpone threshold and batch size, use `Set-SPFarmConfig`. - ## PARAMETERS ### -SiteCollection + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or URL of the site collection. The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. @@ -64,8 +65,7 @@ No other parameters are used. ```yaml Type: SPSitePipeBind Parameter Sets: SiteCollection -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -75,6 +75,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name or URL of the Web application. The type must be a valid name or GUID, in the form WebApplication-1212, or a URL, in the form https://server_name/WebApplication-1212. @@ -82,8 +85,7 @@ The type must be a valid name or GUID, in the form WebApplication-1212, or a URL ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -93,6 +95,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -104,8 +109,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -115,6 +119,9 @@ Accept wildcard characters: False ``` ### -DeclarativeWorkflowsEnabled + +> Applicable: SharePoint Server Subscription Edition + Sets whether declarative workflows are allowed to run in the Web application. The type must be either 1 for True or 0 for False. @@ -122,8 +129,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -133,6 +139,9 @@ Accept wildcard characters: False ``` ### -EmailNoPermissionParticipantsEnabled + +> Applicable: SharePoint Server Subscription Edition + Sets whether workflows send task e-mail messages to users who do not have permissions to the site in which the workflows are running. The type must be either 1 for True or 0 for False. @@ -140,8 +149,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -151,6 +159,9 @@ Accept wildcard characters: False ``` ### -SendDocumentToExternalParticipants + +> Applicable: SharePoint Server Subscription Edition + Sets whether workflows automatically send a copy of the document as an e-mail attachment to participants who do not have access to the site or who are not in any linked directory other than Active Directory Domain Services (AD DS). The type must be either 1 for True or 0 for False. @@ -158,8 +169,7 @@ The type must be either 1 for True or 0 for False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,13 +179,15 @@ Accept wildcard characters: False ``` ### -SingleWorkflowEpisodeTimeout + +> Applicable: SharePoint Server Subscription Edition + Amount of time in seconds given to the workflow to run. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPScaleOutDatabase.md index 0c3eecbf3..01b448652 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPScaleOutDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Moves a specified percentage of partitions from one scale-out database to another. - ## SYNTAX ### NewDatabase @@ -42,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE 1--------------- +### EXAMPLE 1 ```powershell $databases = Get-SPScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -53,7 +52,7 @@ This example creates a new scale-out database named Database2 on the MyDatabaseS The example also moves 30% of the data from the upper side of the data range in the first scale-out database of the given service application. -### ---------------EXAMPLE 2--------------- +### EXAMPLE 2 ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication @@ -67,13 +66,15 @@ This example scales out the Search Analytics database, moving 33% of data to the ## PARAMETERS ### -NewDatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of a new scale-out database that you are creating. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,13 +84,15 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: SharePoint Server Subscription Edition + The source scale-out database to move data from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,13 +102,15 @@ Accept wildcard characters: False ``` ### -SourceServiceApplication + +> Applicable: SharePoint Server Subscription Edition + The service application in which the data move operation will take place. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -TargetDatabase + +> Applicable: SharePoint Server Subscription Edition + The target scale-out database to move data to. ```yaml Type: SPDatabasePipeBind Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -131,6 +138,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -142,8 +152,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -153,6 +162,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -160,7 +172,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -170,14 +181,16 @@ Accept wildcard characters: False ``` ### -MoveLowerHalf + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -187,6 +200,9 @@ Accept wildcard characters: False ``` ### -NewDatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the credentials to use when creating the scale-out database. These credentials will have owner rights on the newly created scale-out database. If a value is not provided, the current user's credentials will be used by default. @@ -194,8 +210,7 @@ If a value is not provided, the current user's credentials will be used by defau ```yaml Type: PSCredential Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,14 +220,16 @@ Accept wildcard characters: False ``` ### -NewDatabaseFailoverServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the failover server name of the new scale-out database to be created. If a value is not provided, the new scale-out database does not have a failover server. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -222,14 +239,16 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the server of the new scale-out database to be created. If a value is not provided, the default database server is used. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -239,14 +258,16 @@ Accept wildcard characters: False ``` ### -SourcePercentage + +> Applicable: SharePoint Server Subscription Edition + Specifies the percentage of data in the source scale-out database to move. If a value is not provided, the default value of 50 percent is used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -256,6 +277,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -263,7 +287,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPServerScaleOutDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPServerScaleOutDatabase.md index 943df571d..75fb9d363 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPServerScaleOutDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Split-SPServerScaleOutDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Moves a specified percentage of partitions from one scale-out database to another. - ## SYNTAX ### NewDatabase @@ -37,10 +36,9 @@ This cmdlet contains more than one parameter set. You may only use parameters fr Use the Split-SPServerScaleOutDatabase cmdlet to move a specified percentage of partitions from a source database to an existing target database or to a new database that you create with the specified parameters. - ## EXAMPLES -### ---------------EXAMPLE--------------- +### EXAMPLE ```powershell $databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication $database = $databases[0] @@ -52,13 +50,15 @@ This example creates a new scale-out database named Database2 on the MyDatabaseS ## PARAMETERS ### -NewDatabaseName + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of a new scale-out database that you are creating. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -68,13 +68,15 @@ Accept wildcard characters: False ``` ### -SourceDatabase + +> Applicable: SharePoint Server Subscription Edition + The source scale-out database to move data from. ```yaml Type: SPDatabasePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -84,14 +86,15 @@ Accept wildcard characters: False ``` ### -SourceServiceApplication -The service application in which the data move operation will take place. +> Applicable: SharePoint Server Subscription Edition + +The service application in which the data move operation will take place. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -101,14 +104,15 @@ Accept wildcard characters: False ``` ### -TargetDatabase -The target scale-out database to move data to. +> Applicable: SharePoint Server Subscription Edition + +The target scale-out database to move data to. ```yaml Type: SPDatabasePipeBind Parameter Sets: ExistingDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -118,16 +122,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection -Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. -Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. +> Applicable: SharePoint Server Subscription Edition +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +Note: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -137,14 +142,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -154,14 +160,15 @@ Accept wildcard characters: False ``` ### -MoveLowerHalf -Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. +> Applicable: SharePoint Server Subscription Edition + +Specifies whether to move the lower or the upper side of the data range from the source scale-out database. If this parameter is not specified, the default behavior is to move the upper side of the source scale-out database data range. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -171,14 +178,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseCredentials -Specifies the credentials to use when creating the scale-out database. These credentials will have owner permissions on the new scale-out database. If you do not provide a value, the credentials of the logged on user will be used. +> Applicable: SharePoint Server Subscription Edition + +Specifies the credentials to use when creating the scale-out database. These credentials will have owner permissions on the new scale-out database. If you do not provide a value, the credentials of the logged on user will be used. ```yaml Type: PSCredential Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -188,14 +196,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseFailoverServer -Specifies the failover server name of the new scale-out database. If you do not provide a value, the new scale-out database does not have a failover server. +> Applicable: SharePoint Server Subscription Edition + +Specifies the failover server name of the new scale-out database. If you do not provide a value, the new scale-out database does not have a failover server. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -205,14 +214,15 @@ Accept wildcard characters: False ``` ### -NewDatabaseServer -Specifies the name of the server of the new scale-out database. If you do not provide a value, the name of the default database server is used. +> Applicable: SharePoint Server Subscription Edition + +Specifies the name of the server of the new scale-out database. If you do not provide a value, the name of the default database server is used. ```yaml Type: String Parameter Sets: NewDatabase -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -222,14 +232,15 @@ Accept wildcard characters: False ``` ### -SourcePercentage -Specifies the percentage of data in the source scale-out database to move. If you do not provide a value, the default value, 50 percent, is used. +> Applicable: SharePoint Server Subscription Edition + +Specifies the percentage of data in the source scale-out database to move. If you do not provide a value, the default value, 50 percent, is used. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -239,15 +250,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAdminJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAdminJob.md index 5aa28b5f0..c2ff3329d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAdminJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAdminJob.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Immediately starts any waiting administrative job on the local computer. - ## SYNTAX ``` @@ -28,20 +27,21 @@ When you run this cmdlet in person (not in script), use the Verbose parameter to For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Start-SPAdminJob -Verbose ``` This example runs all waiting administrative jobs and shows verbose output to the administrator. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,8 +53,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -64,6 +63,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -71,7 +73,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAssignment.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAssignment.md index aab912622..17c16012b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAssignment.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPAssignment.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Initiates a new assignment store. - ## SYNTAX ``` @@ -41,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Start-SPAssignment -global $w = Get-SPWeb https://MyWeb @@ -53,8 +52,7 @@ This example uses simple assignment. Although it is easier to use simple assignment, it is not a good idea to run commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled. Ensure that you run `Stop-SPAssignment` before you attempt any iterations of multiple objects. - -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell $gc = Start-SPAssignment $web = $gc | Get-SPWeb https://MyWeb @@ -66,10 +64,12 @@ This example sets the title of the SPWeb object in multiple lines and controls t This is an advanced example. Only developers are advised to use it. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +81,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +91,9 @@ Accept wildcard characters: False ``` ### -Global + +> Applicable: SharePoint Server Subscription Edition + If you use this parameter, all objects are assigned to the lifetime of the script and are disposed of when the `Stop-SPAssignment` cmdlet is called. If you do not use this parameter, you must assign the output of this cmdlet to a variable and then dispose of objects by using the Identity parameter of the `Stop-SPAssignment` cmdlet. @@ -99,8 +101,7 @@ If you do not use this parameter, you must assign the output of this cmdlet to a ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPCacheCluster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPCacheCluster.md index 1ab32da11..ffcb6e713 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPCacheCluster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPCacheCluster.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Start-SPCacheCluster ``` @@ -35,6 +35,9 @@ This example starts the Caching Services on all cache hosts in the cluster. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -80,7 +87,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPContentDeploymentJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPContentDeploymentJob.md index 02135bcb2..005b1e5a4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPContentDeploymentJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPContentDeploymentJob.md @@ -27,17 +27,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Get-SPContentDeploymentPath "Path 1" | New-SPContentDeploymentJob -Name "Job 1" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false | Start-SPContentDeploymentJob ``` This example creates a content deployment job Job 1 and runs it immediately. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content deployment job to run. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example, DeployJob1); or an instance of a valid SPContentDeploymentJob object. @@ -45,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDeploymentJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -DeploySinceTime + +> Applicable: SharePoint Server Subscription Edition + Specifies the date to use to determine what changes to export incrementally. This parameter is ignored if the deployment job type is full. @@ -103,8 +111,7 @@ The type must be a valid DateTime type, in the form 2010,12,05. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -TestEnabled + +> Applicable: SharePoint Server Subscription Edition + Runs the content deployment job in test mode only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -130,13 +139,15 @@ Accept wildcard characters: False ``` ### -WaitEnabled + +> Applicable: SharePoint Server Subscription Edition + Specifies that the command is not returned until the operation is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -146,6 +157,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -153,7 +167,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -163,13 +176,15 @@ Accept wildcard characters: False ``` ### -UseSpecificSnapshot + +> Applicable: SharePoint Server Subscription Edition + Use a snapshot of the named Content Database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPDiagnosticsSession.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPDiagnosticsSession.md index 083bec911..a45560541 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPDiagnosticsSession.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPDiagnosticsSession.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Starts a diagnostic session to report diagnostic information to the usage database. - ## SYNTAX ``` @@ -26,10 +25,9 @@ After a diagnostic session starts, all Windows PowerShell for SharePoint cmdlets For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### -------------EXAMPLE------- +### EXAMPLE ```powershell $correlationId = [guid]::NewGuid() Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -TraceLevel Verbose @@ -37,10 +35,12 @@ Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -Trace This example starts a diagnostic session for a specified correlation ID with the trace level of verbose. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -52,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -63,13 +62,15 @@ Accept wildcard characters: False ``` ### -CorrelationId + +> Applicable: SharePoint Server Subscription Edition + Specifies the correlation ID to be used for the diagnostic session. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,13 +80,15 @@ Accept wildcard characters: False ``` ### -Dashboard + +> Applicable: SharePoint Server Subscription Edition + Specifies that diagnostics behave as if the developer dashboard were enabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -TraceLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the Unified Logging Service (ULS) trace level override. --High @@ -105,12 +111,10 @@ Specifies the Unified Logging Service (ULS) trace level override. --VerboseEx --None - ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index 8f130b656..bc2b0289e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -25,10 +25,9 @@ The `Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance` cmdlet starts For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance @@ -36,20 +35,20 @@ Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstan This example starts the local query and site settings instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search manager service instance to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. - ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchServiceInstance.md index 0da22971b..6c127be11 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPEnterpriseSearchServiceInstance.md @@ -27,20 +27,21 @@ For permissions and the most current information about Windows PowerShell for Sh If you run this cmdlet on a running search service instance, the associated search components are also restarted. This may lead to a short downtime for queries. - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPEnterpriseSearchServiceInstance -Local | Start-SPEnterpriseSearchServiceInstance ``` This example starts the local search service instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service instance to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -48,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPInfoPathFormTemplate.md index c8a98efc9..9ee7df8c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPInfoPathFormTemplate.md @@ -27,27 +27,27 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Start-SPInfoPathFormTemplate -Identity formName.xsn ``` This example activates a form with a specified name. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to start. The type must be a valid URL, in the form https://server_name; a valid name of a Web application (for example, WebApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPWebServiceProxy object. - ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPService.md index 1e954d13d..43d58ea96 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPService.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/start-spservice -Applicable: SharePoint Server Subscription Edition + title: Start-SPService schema: 2.0.0 --- @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Enables a service in the farm. - ## SYNTAX ``` @@ -25,20 +24,21 @@ The Start-SPService cmdlet enables a service in the farm. Service instances for This cmdlet only controls service instances on servers that are managed by MinRole. The behavior for the Custom server role has changed with the November 2016 Public Update (PU). Please see the IncludeCustomServerRole parameter for additional information. - ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Start-SPService -Identity "Microsoft SharePoint Foundation Sandboxed Code Service" ``` This example enables the Microsoft SharePoint Foundation Sandboxed Code Service in the farm. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -46,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,13 +74,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service to enable. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -89,6 +92,9 @@ Accept wildcard characters: False ``` ### -IncludeCustomServerRole + +> Applicable: SharePoint Server Subscription Edition + Creates a timer job that also starts service instances on servers that are assigned to the custom server role. This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. @@ -96,8 +102,7 @@ This is a one-time Timer job. MinRole will make no further attempts to manage th ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +122,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPServiceInstance.md index 718fd8c15..bc762e03c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPServiceInstance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Starts the service instance for a service on a specific server or the farm. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce ``` @@ -37,10 +36,12 @@ This example starts the given service instance on the server. The service instance GUID is unique to every farm. You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service instances and then use the result from the SPServiceInstance cmdlet for other cmdlets. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service instance to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -48,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -59,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -70,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -81,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -88,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPTimerJob.md b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPTimerJob.md index 1c2581eac..c79512854 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPTimerJob.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Start-SPTimerJob.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Runs a timer job once. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------EXAMPLE---------------- +### EXAMPLE ```powershell Get-SPTimerJob job-recycle-bin-cleanup | Start-SPTimerJob ``` @@ -37,6 +36,9 @@ This example starts the timer job named, job-recycle-bin-cleanup. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the timer job to run. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object. @@ -44,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPTimerJobPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPAssignment.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPAssignment.md index e01d9f239..481a8bd56 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPAssignment.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPAssignment.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Disposes of objects in the provided assignment collection. - ## SYNTAX ``` @@ -27,10 +26,9 @@ Provide a SemiGlobal assignment collector to dispose of all contained objects. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Start-SPAssignment -global $w = Get-SPWeb https://MyWeb @@ -42,17 +40,18 @@ This example uses simple assignment. While easier to use simple assignment, running commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled is not recommended. Ensure that `Stop-SPAssignment` is run before attempting any iterations of multiple objects. - ## PARAMETERS ### -SemiGlobal + +> Applicable: SharePoint Server Subscription Edition + Provides the assignment collector from which to dispose of objects. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -62,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,13 +85,15 @@ Accept wildcard characters: False ``` ### -Global + +> Applicable: SharePoint Server Subscription Edition + Stops the global assignment collector from storing objects and disposes of any objects contained by the global assignment collector. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPCacheCluster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPCacheCluster.md index 248ae8115..f16dda459 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPCacheCluster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPCacheCluster.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Stop-SPCacheCluster ``` @@ -35,6 +35,9 @@ This example stops the Caching Services on all cache hosts in the cluster. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -80,7 +87,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPContentTypeReplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPContentTypeReplication.md index 1a1e13eaa..14b1fe377 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPContentTypeReplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPContentTypeReplication.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.Taxonomy.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/stop-spcontenttypereplication -Applicable: SharePoint Server Subscription Edition + title: Stop-SPContentTypeReplication schema: 2.0.0 --- @@ -23,7 +23,7 @@ Stops Content Type replication job from SharePoint Online and deletes the replic ## EXAMPLES -### -----------------EXAMPLE---------------- +### EXAMPLE ```powershell Stop-SPContentTypeReplication ``` @@ -32,6 +32,9 @@ Stops Content Type replication job from SharePoint Online. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -39,8 +42,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDiagnosticsSession.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDiagnosticsSession.md index 409c416e5..27bfb5853 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDiagnosticsSession.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDiagnosticsSession.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Stops a diagnostic session. - ## SYNTAX ``` @@ -26,17 +25,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE--------- +### EXAMPLE ```powershell Stop-SPDiagnosticsSession ``` This example stops a diagnostic session. - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +49,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDistributedCacheServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDistributedCacheServiceInstance.md index 1f28c176e..6770f5bd9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDistributedCacheServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPDistributedCacheServiceInstance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Stops an instance of the Distributed Cache service on a local server. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------ Example 1 ---------- +### Example 1 ```powershell ``` @@ -36,13 +35,15 @@ Please see referenced article instead of using this cmdlet directly. ## PARAMETERS ### -Graceful + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to gracefully stop an instance of the Distributed Cache service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 1 @@ -52,6 +53,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -63,8 +67,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md index 90cfc2a24..3f804d479 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $qssInstance = Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Local Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstance @@ -35,10 +35,12 @@ Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance -Identity $qssInstanc This example stops the local query and site settings service instance. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search manager service instance to stop. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid SPServer name, or the name of a search manager service instance (for example, SearchManagerServiceInstance1); or an instance of a valid SearchManagerServiceInstance object. @@ -46,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchQueryAndSiteSettingsServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -86,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchServiceInstance.md index 6578d1f71..fb32aaab1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPEnterpriseSearchServiceInstance.md @@ -22,27 +22,28 @@ Stop-SPEnterpriseSearchServiceInstance [-Identity] Applicable: SharePoint Server Subscription Edition + Specifies the shared search service instance to stop. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object. @@ -50,8 +51,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +61,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +75,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +95,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +104,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -107,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPInfoPathFormTemplate.md index 863eaccdd..b5c88a52e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPInfoPathFormTemplate.md @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Stop-SPInfoPathFormTemplate -Identity formName.xsn ``` @@ -38,6 +38,9 @@ This example disables a form template for a specified name. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -45,8 +48,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -TimeLeft + +> Applicable: SharePoint Server Subscription Edition + Specifies the time duration, in minutes, before the form template will be quiesced. The default value is 0. @@ -103,8 +112,7 @@ An integer value in the range from 0 to 1440. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -121,7 +132,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPService.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPService.md index 1f4f81e82..177d5e42b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPService.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPService.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/stop-spservice -Applicable: SharePoint Server Subscription Edition + title: Stop-SPService schema: 2.0.0 --- @@ -22,30 +22,31 @@ Stop-SPService [-Identity] [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + +Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. + +**Note**: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -55,13 +56,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the service to disable. ```yaml Type: SPServicePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -87,14 +92,16 @@ Accept wildcard characters: False ``` ### -IncludeCustomServerRole + +> Applicable: SharePoint Server Subscription Edition + Creates a timer job that also stops service instances on servers that are assigned to the custom server role. **Note**: This is a one-time Timer job. MinRole will make no further attempts to manage the service instances on servers assigned to the Custom server role. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -111,7 +121,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPServiceInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPServiceInstance.md index f92ee1db8..11ad8d0fd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPServiceInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPServiceInstance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Stops the service instance for a service. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Stop-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce ``` @@ -40,13 +39,15 @@ You can run the `Get-SPServiceInstance` cmdlet to see the GUID of the service in ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service instance to get. ```yaml Type: SPServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPTaxonomyReplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPTaxonomyReplication.md index c855307f7..f4e6373b7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPTaxonomyReplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Stop-SPTaxonomyReplication.md @@ -24,7 +24,7 @@ Use the Stop-SPTaxonomyReplication cmdlet to terminate Hybrid SharePoint Taxonom ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Stop-SPTaxonomyReplication -Credential (Get-Credential) ``` @@ -34,6 +34,9 @@ This example performs a full replication and deletes the Taxonomy Groups Replica ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -41,8 +44,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -52,6 +54,9 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: SharePoint Server Subscription Edition + This is the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store. Fetches full taxonomy data properties, so a Term Store Administrator's credential is needed to perform the operations. @@ -59,8 +64,7 @@ Fetches full taxonomy data properties, so a Term Store Administrator's credentia ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPEnterpriseSearchServiceApplication.md index 2844d88d6..83f3258e8 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPEnterpriseSearchServiceApplication.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA $ssa | Suspend-SPEnterpriseSearchServiceApplication @@ -37,6 +37,9 @@ This example obtains a reference to a search service application named MySSA and ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to suspend. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPStateServiceDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPStateServiceDatabase.md index 8f3cf6450..fd0d25cd1 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPStateServiceDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Suspend-SPStateServiceDatabase.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell $db = Get-SPStateServiceDatabase Suspend-SPStateServiceDatabase -Identity $db @@ -38,6 +38,9 @@ This example suspends a specified state service database. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the state database to pause. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object. @@ -46,7 +49,6 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh Type: SPStateDatabasePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -56,6 +58,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +72,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +92,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +101,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPBlobStorage.md b/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPBlobStorage.md index 068aa89ff..fe34b3283 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPBlobStorage.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPBlobStorage.md @@ -34,14 +34,14 @@ The \`Switch-SPBlobStorage\` cmdlet switches the BLOB of a content database betw ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Switch-SPBlobStorage -ContentDatabase "WSS_Content" -SQL ``` This example switches BLOB storage to SQL tables for content database "WSS_Content." -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Switch-SPBlobStorage -RemoteShareBlobStore "RemoteBlobStore" ``` @@ -51,6 +51,9 @@ This example switches BLOB storage to the Remote Share BLOB Store named "RemoteB ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -62,7 +65,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -72,13 +74,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + The content database this operation will be applied to. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: SQL Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -88,6 +92,9 @@ Accept wildcard characters: False ``` ### -RemoteShareBlobStore + +> Applicable: SharePoint Server Subscription Edition + Specifies the Remote Share BLOB Store for new content. It can either be the Remote Share BLOB Store object or the Remote Share BLOB Store name. @@ -96,7 +103,6 @@ It can either be the Remote Share BLOB Store object or the Remote Share BLOB Sto Type: SPRemoteShareBlobStorePipeBind Parameter Sets: RemoteShareBlobStore Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -106,13 +112,15 @@ Accept wildcard characters: False ``` ### -SQL + +> Applicable: SharePoint Server Subscription Edition + Indicates the content database will use SQL for BLOB storage for new content. ```yaml Type: SwitchParameter Parameter Sets: SQL Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -122,13 +130,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -138,6 +148,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -145,7 +158,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPCertificate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPCertificate.md index 05c7c0208..f7bed273c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPCertificate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Switch-SPCertificate.md @@ -27,7 +27,7 @@ All usage of that certificate within SharePoint will then be replaced with the d ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell Switch-SPCertificate -Identity "Team Sites Certificate (2020)" -NewCertificate "Team Sites Certificate (2021)" ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Sync-SPProjectPermissions.md b/sharepoint/sharepoint-server-ps/SharePointServer/Sync-SPProjectPermissions.md index 48017cb4f..5ce706bd6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Sync-SPProjectPermissions.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Sync-SPProjectPermissions.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/sync-spprojectpermissions -Applicable: SharePoint Server Subscription Edition + title: Sync-SPProjectPermissions schema: 2.0.0 --- @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Sync-SPProjectPermissions -Url https://pwa_site -Type Full ``` @@ -45,6 +45,9 @@ Performs a full sync against the PWA site https://pwa_site. ## PARAMETERS ### -Url + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL of the Project Web App instance for which you want to synch permissions. The type must be a valid URL, in the form https://pwa_site. @@ -52,8 +55,7 @@ The type must be a valid URL, in the form https://pwa_site. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -SyncPWASite + +> Applicable: SharePoint Server Subscription Edition + Triggers a synchronization of Project Server permissions to the PWA site. This parameter is used with Project Server permission mode. @@ -70,8 +75,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 2 @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: SharePoint Server Subscription Edition + Specifies the type of sync to perform: full or incremental. This parameter is used with SharePoint permission mode. @@ -92,8 +99,7 @@ Full, Incremental, AllGroups ```yaml Type: SharePointPermissionModeSyncType Parameter Sets: SPMode -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 2 @@ -103,6 +109,9 @@ Accept wildcard characters: False ``` ### -SyncProjectSites + +> Applicable: SharePoint Server Subscription Edition + Triggers a synchronization of Project Server permissions to the project sites. This parameter is used with Project Server permission mode. @@ -110,8 +119,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 3 @@ -121,6 +129,9 @@ Accept wildcard characters: False ``` ### -Async + +> Applicable: SharePoint Server Subscription Edition + Specifies that the synchronization is placed in the Project Server queue. Omitting this flag causes the synchronization to occur immediately within the Windows PowerShell console. @@ -129,8 +140,7 @@ This parameter is used with Project Server permission mode. ```yaml Type: SwitchParameter Parameter Sets: PSMode -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 4 @@ -140,6 +150,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -151,8 +164,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPContentDatabase.md index 2b86a1f88..eb6f334ad 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPContentDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Tests a content database. - ## SYNTAX ### ContentDatabaseById @@ -45,15 +44,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Test-SPContentDatabase -name WSS_Content_DB -webapplication https://sitename ``` This example tests the WSS_Content_DB content database against the sitename Web application and returns a list of issues. - -### ----------------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell $DB = Get-SPContentDatabase -site https://contoso.com Test-SPContentDatabase $DB -showrowcounts @@ -65,13 +63,15 @@ Together with displaying the list of issues, by specifying the ShowRowCounts par ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies an existing connected SharePoint content database to one of the two parameter sets in the form of a GUID or database name if it is unique. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -81,6 +81,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the existing content database to test. The type must be a valid name of a SharePoint content database; for example, SPContentDB1. @@ -88,8 +91,7 @@ The type must be a valid name of a SharePoint content database; for example, SPC ```yaml Type: String Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -99,6 +101,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint Web application to use to test the content database. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -106,8 +111,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -117,6 +121,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -128,8 +135,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -139,6 +145,9 @@ Accept wildcard characters: False ``` ### -DatabaseCredentials + +> Applicable: SharePoint Server Subscription Edition + Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. @@ -146,8 +155,7 @@ The type must be a valid PSCredential object. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExtendedCheck + +> Applicable: SharePoint Server Subscription Edition + Checks for inconsistent authentication modes during database-attach upgrade process. The selected mode, claims or classic, must be the same in both versions. @@ -164,8 +175,7 @@ The selected mode, claims or classic, must be the same in both versions. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -175,6 +185,9 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server Subscription Edition + Specifies the instance of the database service to use to test the specified content database. The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SQL Server instance (for example, DBSvrInstance1); or an instance of a valid SPDatabaseServiceInstance object. @@ -182,8 +195,7 @@ The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -193,6 +205,9 @@ Accept wildcard characters: False ``` ### -ShowLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the locations where missing templates and features are being used within the database. Typically, reported locations are scoped within the site collections that are within the specified content database. @@ -201,8 +216,7 @@ The use of the parameter significantly increases the time to complete the test p ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -212,13 +226,15 @@ Accept wildcard characters: False ``` ### -ShowRowCounts + +> Applicable: SharePoint Server Subscription Edition + Returns database statistics which are row counts for tables in the content database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPInfoPathFormTemplate.md index be688e5ec..86e502d01 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPInfoPathFormTemplate.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Test-SPInfoPathFormTemplate -Identity formName.xsn ``` @@ -36,6 +36,9 @@ This example validates an InfoPath form template for a specified name. ## PARAMETERS ### -Path + +> Applicable: SharePoint Server Subscription Edition + Specifies the path and name of the InfoPath form template to install. The type must be a valid path and file name of a form template, in the form: @@ -46,8 +49,7 @@ The type must be a valid path and file name of a form template, in the form: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -57,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -68,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPO365LinkSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPO365LinkSettings.md index 6c60bbb1c..d355831fa 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPO365LinkSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPO365LinkSettings.md @@ -10,7 +10,7 @@ schema: 2.0.0 # Test-SPO365LinkSettings ## SYNOPSIS -Validates whether the configured Office 365 hybrid site uses a valid template. +Validates whether the configured Office 365 hybrid site uses a valid template. ## SYNTAX @@ -24,7 +24,7 @@ Use the **Test-SPO365LinkSettings** cmdlet to validate a templated against a con ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Test-SPO365LinkSettings -MySiteHostUrl https://contoso-my.sharepoint.com/ ``` @@ -34,6 +34,9 @@ This example test a template using the contoso-my.sharepoint site. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -45,8 +48,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -MySiteHostUrl + +> Applicable: SharePoint Server Subscription Edition + The root URL for the redirected pages ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,7 +78,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## RELATED LINKS [Get-SPO365LinkSettings](Get-SPO365LinkSettings.md) diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectServiceApplication.md index 808f7c37f..47e8d93b2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectServiceApplication.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/test-spprojectserviceapplication -Applicable: SharePoint Server Subscription Edition + title: Test-SPProjectServiceApplication schema: 2.0.0 --- @@ -25,7 +25,7 @@ This cmdlet runs a series of health checks against the Project Service Applicati ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'} Test-SPProjectServiceApplication -Identity $sa @@ -36,6 +36,9 @@ This example runs all health checks again the service application named "Project ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -43,8 +46,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -54,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + The name of the Project Service Application to test against. ```yaml Type: PsiServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -70,6 +74,9 @@ Accept wildcard characters: False ``` ### -Rule + +> Applicable: SharePoint Server Subscription Edition + Which rule to run against the service application. Valid rules are: @@ -87,9 +94,8 @@ DatabasePermissions ```yaml Type: ProjectServiceApplicationHealthRuleName Parameter Sets: (All) -Aliases: +Aliases: Accepted values: All, QueueServiceInternalState, QueueInFlightJobs, CalcServiceWorkerState, DatabasePermissions -Applicable: SharePoint Server Subscription Edition Required: False Position: 1 diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectWebInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectWebInstance.md index 26e561ea5..8a2c5bdf6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectWebInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPProjectWebInstance.md @@ -2,7 +2,7 @@ external help file: microsoft.office.project.server.stsadmcommandhandler.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/test-spprojectwebinstance -Applicable: SharePoint Server Subscription Edition + title: Test-SPProjectWebInstance schema: 2.0.0 --- @@ -28,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Pr ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Get-SPProjectWebInstance | Test-SPProjectWebInstance ``` @@ -38,13 +38,15 @@ This example runs a suite of tests on all Project Web Instances in the SharePoin ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies a Project Web Instance. ```yaml Type: ProjectInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -54,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -65,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -76,13 +80,15 @@ Accept wildcard characters: False ``` ### -Rule + +> Applicable: SharePoint Server Subscription Edition + {{Fill Rule Description}} ```yaml Type: ProjectSiteHealthRuleName Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPRemoteShareBlobStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPRemoteShareBlobStore.md index c5c2c10eb..e12cfb09b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPRemoteShareBlobStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPRemoteShareBlobStore.md @@ -25,7 +25,7 @@ The test verifies the permissions of the Remote Share BLOB stores and identifies ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Test-SPRemoteShareBlobStore -ContentDatabase "WSS_Content" ``` @@ -33,7 +33,7 @@ Test-SPRemoteShareBlobStore -ContentDatabase "WSS_Content" Tests all the Remote Share BLOB Stores in the WSS_Content content database. The log file is written to the default SharePoint trace log path. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Test-SPRemoteShareBlobStore -ContentDatabase "WSS_Content" -LogPath C:\Logs\SharePointBlobTest.txt ``` @@ -44,6 +44,9 @@ The log file is written to C:\Logs\SharePointBlobTest.txt. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -55,7 +58,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ``` ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies a content database to get the Remote Share BLOB Store. ```yaml Type: SPContentDatabasePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -81,6 +85,9 @@ Accept wildcard characters: False ``` ### -LogPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path of the log file that contains the results of the test. If this parameter is not specified, the log file will be written to the default SharePoint trace log path. @@ -88,7 +95,6 @@ If this parameter is not specified, the log file will be written to the default Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -121,7 +132,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPSite.md index a4078c069..7b755fc27 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Test-SPSite.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Activates the RunTests method against a referenced SPSite object. - ## SYNTAX ``` @@ -30,14 +29,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE 1------------ +### EXAMPLE 1 ```powershell Test-SPSite https:///sites/testsite ``` This example runs all the site collection health checks on the https://\/sites/testsite site collection. -### --------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell Test-SPSite https:// Applicable: SharePoint Server Subscription Edition + Specifies the URL or GUID of the site to run a test. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -63,6 +64,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +78,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,13 +88,15 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: SharePoint Server Subscription Edition + Specifies one specific site health rule to run. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -RunAlways + +> Applicable: SharePoint Server Subscription Edition + Forces a rule to run even if a health check was run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPAppInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPAppInstance.md index 52008c270..f9dde22f5 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPAppInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPAppInstance.md @@ -12,8 +12,7 @@ schema: 2.0.0 ## SYNOPSIS Uninstalls an instance of an app. - -## SYNTAX +## SYNTAX ``` Uninstall-SPAppInstance -Identity [-AssignmentCollection ] [-Confirm] @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE-------------- +### EXAMPLE ```powershell $spapp = Get-SPAppInstance -AppInstanceId $instance.Id Uninstall-SPAppInstance -Identity $spapp @@ -36,17 +35,18 @@ Uninstall-SPAppInstance -Identity $spapp This example uninstalls an instance of an app. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the app instance for which to find metadata. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPDataConnectionFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPDataConnectionFile.md index 083a51b5c..5f0af42df 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPDataConnectionFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPDataConnectionFile.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Uninstall-SPDataConnectionFile -Identity "Sample.udcx "Sample1.udcx", "Sample2.udcx", "Sample3.udcx" | Uninstall-SPDataConnectionFile @@ -37,6 +37,9 @@ This example uninstalls a specified data connection file in two different ways. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the data connection file to remove. The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object. @@ -44,8 +47,7 @@ The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a ```yaml Type: SPDataConnectionFilePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPFeature.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPFeature.md index c2901745d..e0c0a323d 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPFeature.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPFeature.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Uninstalls an installed feature definition. - ## SYNTAX ``` @@ -27,14 +26,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell Uninstall-SPFeature -Identity "MyCustomFeature" ``` This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml. -### ------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Uninstall-SPFeature -Identity "MyCustomFeature" -CompatibilityLevel 14 ``` @@ -44,6 +43,9 @@ This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the feature or GUID to uninstall. The type must be the name of the feature folder located in the \:\program files\common files\Microsoft Shared\Web server extensions\15\template\features folder, or must be a GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. @@ -51,8 +53,7 @@ The type must be the name of the feature folder located in the \:\progra ```yaml Type: SPFeatureDefinitionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -62,6 +63,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -73,8 +77,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -84,15 +87,16 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies the version of feature to uninstall. When the version is not specified it will default to the web applications MaxVersion value. - ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -102,6 +106,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -109,7 +116,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -119,13 +125,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the uninstallation of a feature that is already installed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -135,6 +143,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -142,7 +153,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPHelpCollection.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPHelpCollection.md index 40730f0c4..269eab82a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPHelpCollection.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPHelpCollection.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Removes Help collection files. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Uninstall-SPHelpCollection -Name "OSSAdmin.1033" ``` @@ -38,6 +37,9 @@ The folder name of the Help collection to uninstall is OSSAdmin.1033. ## PARAMETERS ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of the Help collection files to uninstall. The type must be a valid name of a Help collection; for example, HelpDocs1. @@ -45,8 +47,7 @@ The type must be a valid name of a Help collection; for example, HelpDocs1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPInfoPathFormTemplate.md index 5ab66bb18..f98c2eb02 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPInfoPathFormTemplate.md @@ -26,17 +26,19 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Uninstall-SPInfoPathFormTemplate -Identity formName.xsn ``` This example removes an InfoPath form template from a farm. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the InfoPath form template to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate object. @@ -44,8 +46,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPFormTemplatePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -55,6 +56,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -66,8 +70,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -84,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -101,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPSolution.md index 0d041ee78..0ed5c501f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Retracts a deployed SharePoint solution. - ## SYNTAX ### AllWebApplication @@ -40,10 +39,9 @@ Use the `Remove-SPSolution` cmdlet to delete the solution package from the solut For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Uninstall-SPSolution -Identity contoso_solution.wsp ``` @@ -53,6 +51,9 @@ This example retracts the deployed SharePoint solution contoso_solution.wsp. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint solution to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -60,8 +61,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -71,13 +71,15 @@ Accept wildcard characters: False ``` ### -AllWebApplications + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new SharePoint solution will be uninstalled for all SharePoint Web applications in the farm. ```yaml Type: SwitchParameter Parameter Sets: AllWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +89,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Uninstalls the SharePoint solution for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. @@ -94,8 +99,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPWebApplicationPipeBind Parameter Sets: OneWebApplication -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -105,6 +109,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -116,8 +123,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -127,6 +133,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -134,7 +143,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -144,13 +152,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -160,6 +170,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Uninstalls the language pack for the specified language. The type must be a valid language identifier; for example, 1033. @@ -167,8 +180,7 @@ The type must be a valid language identifier; for example, 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -178,13 +190,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Uninstalls the solution from the active server computer. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -194,6 +208,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server Subscription Edition + Specifies when the solution will be uninstalled. The default value is immediate retraction. @@ -202,8 +219,7 @@ The type must be a valid DateTime value, in the form 2010,12,05. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -213,6 +229,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -220,7 +239,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPUserSolution.md index fb064b469..840cfb273 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPUserSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Deactivates a sandboxed solution in a site collection. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE--------------- +### EXAMPLE ```powershell Uninstall-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename ``` @@ -38,6 +37,9 @@ This example deactivates the sandboxed solution contoso_solution.wsp on the site ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution to deactivate. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -45,8 +47,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Deactivates the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object. @@ -63,8 +67,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -74,6 +77,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -85,8 +91,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -103,7 +111,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -113,6 +120,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +130,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPWebPartPack.md b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPWebPartPack.md index bb2aa4484..1758e000f 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPWebPartPack.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Uninstall-SPWebPartPack.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Uninstalls the specified Web Part package. - ## SYNTAX ``` @@ -28,14 +27,14 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Uninstall-SPWebPartPack "mypart.wpp" -WebApplication https://portal ``` This example uninstalls mypart.wpp to from the Web application https://portal. -### ------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Get-SPWebPartPack -WebApplication https://portal | Uninstall-SPWebPartPack ``` @@ -45,13 +44,15 @@ This example uninstalls all Web part packages from the Web application https://p ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web Part package in the farm's configuration database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -72,8 +76,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -90,7 +96,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Language + +> Applicable: SharePoint Server Subscription Edition + Specifies the language ID of the Web Part package to delete. If no language is specified, the Web Part package is uninstalled for all languages. @@ -108,8 +116,7 @@ The type must be a valid language identifier, in the form 1033. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the Web application from which to uninstall the Web Part package. If no Web application is specified, the Web Part package is uninstalled from all Web applications. @@ -127,8 +137,7 @@ The type must be a valid name, in the form WebApplication-1212, or a URL, in the ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -138,6 +147,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -145,7 +157,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -155,13 +166,15 @@ Accept wildcard characters: False ``` ### -CompatibilityLevel + +> Applicable: SharePoint Server Subscription Edition + {{Fill CompatibilityLevel Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Unpublish-SPServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Unpublish-SPServiceApplication.md index 99a40f540..5eaec18f6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Unpublish-SPServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Unpublish-SPServiceApplication.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Stops sharing the specified service application outside the farm. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell UnPublish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 ``` @@ -40,6 +39,9 @@ You can run the `Get-SPServiceApplication` cmdlet to see the GUID of the service ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the GUID of the service application to stop sharing outside the farm. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -69,8 +73,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -87,7 +93,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -104,7 +112,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPRemoteShareBlobStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPRemoteShareBlobStore.md index 901213365..875cdf8ff 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPRemoteShareBlobStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPRemoteShareBlobStore.md @@ -24,7 +24,7 @@ The \`Unregister-SPRemoteShareBlobStore\` cmdlet unregisters a Remote Share BLOB ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Register-SPRemoteShareBlobStore -RemoteShareBlobStore "RemoteBlobStore" -Force ``` @@ -34,6 +34,9 @@ This example forcely unregisters "RemoteBlobStore" from the farm ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -45,7 +48,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -55,6 +57,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + This switch forces unregistration even if there are BLOBs still in use in the Remote Share BLOB Store. If there are BLOBs still in use in the BLOB store being unregistered, this cmdlet will throw an exception to prevent unintentionally unregistering a BLOB store in use. @@ -67,7 +72,6 @@ It's recommended to first migrate BLOBs and then unregister the Remote Share BLO Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -RemoteShareBlobStore + +> Applicable: SharePoint Server Subscription Edition + Specifies the identity of the Remote Share BLOB Store to unregister. It can either be the Remote Share BLOB Store object or the Remote Share BLOB Store name. @@ -85,7 +92,6 @@ It can either be the Remote Share BLOB Store object or the Remote Share BLOB Sto Type: SPRemoteShareBlobStorePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -95,13 +101,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -111,6 +119,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -118,7 +129,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPVssWriter.md b/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPVssWriter.md index 0a66626e3..645567993 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPVssWriter.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Unregister-SPVssWriter.md @@ -24,7 +24,7 @@ This prevents the Volume Shadow Copy Service (VSS) from backing up and restoring ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Unregister-SPVssWriter ``` @@ -34,6 +34,9 @@ Unregisters the SharePoint VSS Writer service on the local server. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppCatalogConfiguration.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppCatalogConfiguration.md index 2248f297d..d10a46baf 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppCatalogConfiguration.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppCatalogConfiguration.md @@ -26,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE----------- +### EXAMPLE ```powershell Update-SPAppCatalogConfiguration -Site https://contoso/sites/appcatalog_1 -Force:$true -SkipWebTemplateChecking:$true ``` @@ -35,14 +35,15 @@ This example sets https://contoso/sites/appcatalog_1 as the app catalog site col ## PARAMETERS ### -Site -Specifies the URL or GUID of the site collection to be set as the app catalog site collection. +> Applicable: SharePoint Server Subscription Edition + +Specifies the URL or GUID of the site collection to be set as the app catalog site collection. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -52,16 +53,17 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. - ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -71,14 +73,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +> Applicable: SharePoint Server Subscription Edition + +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Specifies to force marking the site collection even if there are validation errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -104,13 +109,15 @@ Accept wildcard characters: False ``` ### -SkipWebTemplateChecking + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to skip checking if the template of the site is APPCATALOG#0. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -120,15 +127,16 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppInstance.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppInstance.md index c35e27ec9..2e714e7da 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppInstance.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAppInstance.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the app instance. - ## SYNTAX ``` @@ -25,10 +24,9 @@ Use the `Update-SPAppInstance` cmdlet to update the app instance. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - ## EXAMPLES -### --------EXAMPLE--------- +### EXAMPLE ```powershell $spapp = Import-SPAppPackage -Path .\feature-upgrade-v2.spapp -Site https://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel) $instance = Get-SPAppInstance -AppInstanceId $instance.Id @@ -37,17 +35,18 @@ Update-SPAppInstance -Identity $instance -App $spapp This example updates an instance of an app. - ## PARAMETERS ### -App + +> Applicable: SharePoint Server Subscription Edition + Specifies the app version to upgrade to. ```yaml Type: SPApp Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -57,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies The app instance to upgrade. ```yaml Type: SPAppInstance Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -73,6 +74,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +88,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +98,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +117,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +127,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAzureBlobConfigLocatorEx1.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAzureBlobConfigLocatorEx1.md index d4e0d938c..0a9c27b60 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAzureBlobConfigLocatorEx1.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPAzureBlobConfigLocatorEx1.md @@ -24,7 +24,7 @@ Update-SPAzureBlobConfigLocatorEx1 [-AssignmentCollection Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -Locator + +> Applicable: SharePoint Server Subscription Edition + {{ Fill Locator Description }} ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDataRetrievalServiceConfig.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDataRetrievalServiceConfig.md index 7880ee623..6bac340f6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDataRetrievalServiceConfig.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDataRetrievalServiceConfig.md @@ -38,21 +38,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Update-SPDataRetrievalServiceConfig -Farm -Enable $false ``` This example turns off the data retrieval service for the farm. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Update-SPDataRetrievalServiceConfig -WebApplication http://MyOfficeApp1 -Inherit ``` This example enables the Web application, MyOfficeApp1, to inherit the global settings. -### -------------EXAMPLE 3------------- +### EXAMPLE 3 ```powershell Update-SPDataRetrievalServiceConfig -WebApplication http://MyOfficeApp1 -Enable $false ``` @@ -62,6 +62,9 @@ This example turns off the data retrieval service for the Web application, MyOff ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,7 +77,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -84,6 +86,9 @@ Accept wildcard characters: False ``` ### -DataSourceTimeout + +> Applicable: SharePoint Server Subscription Edition + Set the response timeout in second. This setting applies to the following data retrieval services: @@ -102,7 +107,6 @@ XmlUrlDataSource Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,13 +116,15 @@ Accept wildcard characters: False ``` ### -Enable + +> Applicable: SharePoint Server Subscription Edition + @{Text=} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -128,6 +134,9 @@ Accept wildcard characters: False ``` ### -EnableDataSourceControls + +> Applicable: SharePoint Server Subscription Edition + Enable or disable the set of data source controls on this server. This setting applies to the following data source controls: @@ -144,7 +153,6 @@ AggregateDataSource Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -154,6 +162,9 @@ Accept wildcard characters: False ``` ### -EnableUpdateSupport + +> Applicable: SharePoint Server Subscription Edition + Enable or disable the support for update queries. This setting applies to the following data retrieval services: @@ -164,7 +175,6 @@ OLEDB Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -174,13 +184,15 @@ Accept wildcard characters: False ``` ### -Farm + +> Applicable: SharePoint Server Subscription Edition + Apply the setting to the farm, and to all the SharePoint Web applications inherit the config. ```yaml Type: SwitchParameter Parameter Sets: Farm Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -190,13 +202,15 @@ Accept wildcard characters: False ``` ### -Inherit + +> Applicable: SharePoint Server Subscription Edition + Set whether inherit the global setting of the farm. ```yaml Type: SwitchParameter Parameter Sets: WebApplication Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -206,13 +220,15 @@ Accept wildcard characters: False ``` ### -LimitResponseSize + +> Applicable: SharePoint Server Subscription Edition + The maximum size of the SOAP response that the data source returns to the data retrieval service, specified by kilobytes(KB). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -222,13 +238,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Apply the setting to the specified SharePoint Web application. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApplication Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: 1 @@ -238,13 +256,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -254,13 +274,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDistributedCacheSize.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDistributedCacheSize.md index 059257417..f60c200f0 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDistributedCacheSize.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPDistributedCacheSize.md @@ -24,25 +24,25 @@ Use the Update-SPDistributedCacheSize cmdlet to allocate memory to the Distribut ## EXAMPLES -### -------------EXAMPLE---------- +### EXAMPLE ```powershell Update-SPDistributedCacheSize -CacheSizeInMB 2048 ``` Updates the Distributed Cache size to 2048MB. - ## PARAMETERS ### -CacheSizeInMB -Specifies the memory size in megabytes (MB) that you want to allocate to the Distributed Cache service. The default value is 5 percent of total system random access memory (RAM). This value should not be more than 40 percent of total system RAM with a maximum limit of 16 gigabytes (GB). +> Applicable: SharePoint Server Subscription Edition + +Specifies the memory size in megabytes (MB) that you want to allocate to the Distributed Cache service. The default value is 5 percent of total system random access memory (RAM). This value should not be more than 40 percent of total system RAM with a maximum limit of 16 gigabytes (GB). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -52,6 +52,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -59,8 +62,7 @@ NOTE: When the Global parameter is used, all objects are contained in the global ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFarmEncryptionKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFarmEncryptionKey.md index 21344a159..9796715be 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFarmEncryptionKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFarmEncryptionKey.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Changes the value of the farm encryption key and using the new key, re-encrypts all the data. - ## SYNTAX ``` @@ -28,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Update-SPFarmEncryptionKey -confirm ``` @@ -38,6 +37,9 @@ This example changes the farm encryption key to a new value and re-encrypts all ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -49,8 +51,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -60,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -67,7 +71,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -77,13 +80,15 @@ Accept wildcard characters: False ``` ### -Resume + +> Applicable: SharePoint Server Subscription Edition + Resumes re-encryption of data with the new farm encryption key if a previous attempt failed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -93,6 +98,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -100,7 +108,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFlightsConfigFile.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFlightsConfigFile.md index 82bae5766..bfc9e0e40 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFlightsConfigFile.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPFlightsConfigFile.md @@ -24,7 +24,7 @@ Use the Update-SPFlightsConfigFile cmdlet to update the SPFlightsConfigFile in t ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Update-SPFlightsConfigFile -FilePath C:\Users\Administrator\Downloads\SPFlightRawConfig.json ``` @@ -34,6 +34,9 @@ This example updates the SPFlightsConfigFile in the content database with C:\Dow ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -46,7 +49,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -56,13 +58,15 @@ Accept wildcard characters: False ``` ### -FilePath + +> Applicable: SharePoint Server Subscription Edition + Enter Flights config file path. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -88,6 +94,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -95,7 +104,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathAdminFileUrl.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathAdminFileUrl.md index aeda24dea..831a2aca6 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathAdminFileUrl.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathAdminFileUrl.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPWebApplication http://contoso2010 | Update-SPInfoPathAdminFileUrl -find "http://contoso2007" -replace "http://contoso2010" ``` @@ -40,6 +40,9 @@ Data connections that reference http://contoso 2007 are updated to reference htt ## PARAMETERS ### -Find + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to find. The type must be a valid URL, in the form http://previous_server_name. @@ -47,8 +50,7 @@ The type must be a valid URL, in the form http://previous_server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -58,6 +60,9 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to find. The type must be a valid URL, in the form http://server_name. @@ -65,8 +70,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,14 +123,16 @@ Accept wildcard characters: False ``` ### -Scan + +> Applicable: SharePoint Server Subscription Edition + Run the tool and log the actions that can be taken. No content is changed as a result of the scan. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -132,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -139,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathFormTemplate.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathFormTemplate.md index 8cc405ff0..24fb80c68 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathFormTemplate.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathFormTemplate.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ---------------EXAMPLE-------------- +### EXAMPLE ```powershell Update-SPInfoPathFormTemplate ``` @@ -37,6 +37,9 @@ This example updates InfoPath form templates on the entire farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +51,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,6 +61,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -66,7 +71,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -83,7 +90,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathUserFileUrl.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathUserFileUrl.md index 4c9f20d05..cf4673163 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathUserFileUrl.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPInfoPathUserFileUrl.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files). - ## SYNTAX ### ContentDB @@ -45,7 +44,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Get-SPWebApplication http://contoso2010 | Update-SPInfoPathUserFileUrl -Find "http://contoso2007" -Replace "http://contoso2010" ``` @@ -57,6 +56,9 @@ Data connections that reference http://contoso2007 are updated to reference http ## PARAMETERS ### -ContentDatabase + +> Applicable: SharePoint Server Subscription Edition + Specifies the parent content database where the update will start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content database (for example, SPContent DB1); or an instance of a valid SPContentDatabase object. @@ -64,8 +66,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDB -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -75,6 +76,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Specifies the parent site collection where the update will start. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://sites/example; or an instance of a valid SPSite object. @@ -82,8 +86,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: Site -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the parent SharePoint Web application where the update will start. The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object @@ -100,8 +106,7 @@ The type must be a valid URL, in the form http://server_name; a valid GUID, in t ```yaml Type: SPWebApplicationPipeBind Parameter Sets: WebApp -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -111,6 +116,9 @@ Accept wildcard characters: False ``` ### -Find + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to find. The type must be a valid URL, in the form http://previous_server_name. @@ -118,8 +126,7 @@ The type must be a valid URL, in the form http://previous_server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -129,6 +136,9 @@ Accept wildcard characters: False ``` ### -Replace + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL to find. The type must be a valid URL, in the form http://server_name. @@ -136,8 +146,7 @@ The type must be a valid URL, in the form http://server_name. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -158,8 +170,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +190,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -186,14 +199,16 @@ Accept wildcard characters: False ``` ### -Scan + +> Applicable: SharePoint Server Subscription Edition + Run the tool and log the actions that can be taken. No content is changed as a result of the scan. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -203,6 +218,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -210,7 +228,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPMachineKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPMachineKey.md index 5b87f16fd..daadf61fc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPMachineKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPMachineKey.md @@ -24,14 +24,14 @@ The \`Update-SPMachineKey\` cmdlet deploys ASP.NET view state decryption and val ## EXAMPLES -### -------------EXAMPLE 1------------- +### EXAMPLE 1 ```powershell Update-SPMachineKey -WebApplication http://sitename ``` This example deploys the ASP.NET view state decryption and validation keys stored in the configuration database for web application 'http://sitename' to all servers in the farm. -### -------------EXAMPLE 2------------- +### EXAMPLE 2 ```powershell Update-SPMachineKey -WebApplication http://sitename -Local ``` @@ -41,6 +41,9 @@ This example deploys the ASP.NET view state decryption and validation keys store ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -53,7 +56,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Deploy the decryption and validation keys only to the local server. Other servers in the farm will continue to use the previous decryption and validation keys. Web sessions that are load balanced across multiple servers in the farm will fail if these keys are not synchronized on every server in the farm. @@ -73,7 +78,6 @@ If this parameter is not specified, the decryption and validation keys will be d Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the name, URL, or GUID of the Web application. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -99,13 +105,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,6 +123,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -122,7 +133,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfilePhotoStore.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfilePhotoStore.md index 835bfbe47..9e20333dd 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfilePhotoStore.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfilePhotoStore.md @@ -37,7 +37,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------- +### EXAMPLE ```powershell Update-SPProfilePhotoStore -MySiteHostLocation https://mysites ``` @@ -47,13 +47,15 @@ This example uploads photos to a specified My Site host location. ## PARAMETERS ### -MySiteHostLocation + +> Applicable: SharePoint Server Subscription Edition + Specifies the URL for the My Site host location where the photos are to be uploaded. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -63,6 +65,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -74,8 +79,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -85,13 +89,15 @@ Accept wildcard characters: False ``` ### -CreateThumbnailsForImportedPhotos + +> Applicable: SharePoint Server Subscription Edition + Creates thumbnails for all the imported user profile pictures. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,14 +107,16 @@ Accept wildcard characters: False ``` ### -NewBaseUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the new URL for profile pictures. For example, https://server2/. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -118,6 +126,9 @@ Accept wildcard characters: False ``` ### -NoDelete + +> Applicable: SharePoint Server Subscription Edition + When the value is set to true, imported user profile picture files will be preserverd after creating thumbnails for them. > [!NOTE] > This will only work when CreateThumbnailsForImportedPhotos is set to `$true` @@ -125,8 +136,7 @@ When the value is set to true, imported user profile picture files will be prese ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -136,14 +146,16 @@ Accept wildcard characters: False ``` ### -OldBaseUri + +> Applicable: SharePoint Server Subscription Edition + Specifies the old URL for profile pictures. For example, https://server1/. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfileSync.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfileSync.md index 795256970..5da5650ea 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfileSync.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPProfileSync.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/update-spprofilesync -applicable: +applicable: title: Update-SPProfileSync online version: schema: 2.0.0 @@ -26,14 +26,14 @@ The Update-SPProfileSync cmdlet updates the configuration of the User Profile Sy ## EXAMPLES -### ------------EXAMPLE 1----------- +### EXAMPLE 1 ```powershell Update-SPProfileSync -IgnoreIsActive:$true ``` This example updates the User Profile Synchronization job marking it to sync all users irrespective of their activity, without prompting for user confirmation. -### ------------EXAMPLE 2----------- +### EXAMPLE 2 ```powershell Update-SPProfileSync -SynchronizationTiming "every 15 minutes" ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogFeedCache.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogFeedCache.md index 6d4417dd8..6b2bac9e7 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogFeedCache.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogFeedCache.md @@ -52,7 +52,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE 1------------ +### EXAMPLE 1 ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} @@ -61,7 +61,7 @@ Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -Ac This example refreshes the feed for a specific user by using the AccountName parameter. -### ------------EXAMPLE 2------------ +### EXAMPLE 2 ```powershell $site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0] @@ -76,7 +76,7 @@ while($profiles.MoveNext()) { This example refreshes the feeds for all users in the User Profile Service Application. -### ------------EXAMPLE 3------------ +### EXAMPLE 3 ```powershell Update-SPRepopulateMicroblogFeedCache -ProfileServiceApplicationProxy $proxy -SiteUrl https://sharepoint.contoso.com @@ -88,13 +88,14 @@ This example refreshes the feed on the site https://sharepoint.contoso.com. ### -AccountName +> Applicable: SharePoint Server Subscription Edition + Specifies the user's account name for the User Profile Service application. ```yaml Type: String Parameter Sets: (All), Default Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -105,6 +106,8 @@ Accept wildcard characters: False ### -ProfileServiceApplicationProxy +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service application proxy to update. The type must be in one of the following forms: @@ -117,7 +120,6 @@ The type must be in one of the following forms: Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -128,6 +130,8 @@ Accept wildcard characters: False ### -AssignmentCollection +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -140,7 +144,6 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -151,14 +154,15 @@ Accept wildcard characters: False ### -SiteSubscription +> Applicable: SharePoint Server Subscription Edition + Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment. ```yaml Type: SPSiteSubscriptionPipeBind -Parameter Sets: (All), Default +Parameter Sets: (All), Default, FollowableList Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -167,28 +171,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -```yaml -Type: SPSiteSubscriptionPipeBind -Parameter Sets: FollowableList -Aliases: -Applicable: SharePoint Server Subscription Edition - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -SiteUrl +> Applicable: SharePoint Server Subscription Edition + Specifies the Site's URL to repopulate the site feeds. If you don't specify this parameter, you must specify the AccountName parameter. If neither parameter is specified, an error message is displayed. ```yaml Type: String Parameter Sets: (All), Default Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -199,13 +191,14 @@ Accept wildcard characters: False ### -ListId +> Applicable: SharePoint Server Subscription Edition + The ListId of the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -216,13 +209,14 @@ Accept wildcard characters: False ### -ListRootFolderUrl +> Applicable: SharePoint Server Subscription Edition + The RootFolderUrl of the FollowableList. ```yaml Type: String Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -233,13 +227,14 @@ Accept wildcard characters: False ### -SiteId +> Applicable: SharePoint Server Subscription Edition + The SiteId containing the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named @@ -250,13 +245,14 @@ Accept wildcard characters: False ### -WebId +> Applicable: SharePoint Server Subscription Edition + The WebId containing the FollowableList. ```yaml Type: Guid Parameter Sets: FollowableList Aliases: -Applicable: SharePoint Server Subscription Edition Required: True Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogLMTCache.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogLMTCache.md index 6a1a05d4e..2e684122c 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogLMTCache.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPRepopulateMicroblogLMTCache.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------EXAMPLE----------- +### EXAMPLE ```powershell $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'} Update-SPRepopulateMicroblogLMTCache -ProfileServiceApplicationProxy $proxy @@ -40,11 +40,13 @@ This example refreshes the cache for the specified proxy. ## PARAMETERS ### -ProfileServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service application proxy to update. The type must be in one of the following forms: - --A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh --A valid name of a service application proxy (for example, UserProfileSvcProxy1) @@ -54,8 +56,7 @@ The type must be in one of the following forms: ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -65,6 +66,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -76,8 +80,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreApplicationServerKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreApplicationServerKey.md index 1194ef4ab..30e0ebf8a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreApplicationServerKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreApplicationServerKey.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $newPassPhrase = "abcDEF123!" $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} @@ -45,13 +45,15 @@ This example synchronizes the passphrase of the server key on a SharePoint serve ## PARAMETERS ### -Passphrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the passphrase that is used for the Secure Store service database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -61,13 +63,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the service application that contains the server key to synchronize. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -77,6 +81,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -88,8 +95,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreCredentialMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreCredentialMapping.md index 25bff3a1e..efec8e48b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreCredentialMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreCredentialMapping.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication" $firstCredential = ConvertTo-SecureString "LOBDATABASE\jdoe" -AsPlainText -Force @@ -43,13 +43,15 @@ This user is mapped to a pair of credential values on the External System with a ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Store Service application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -Principal + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPClaims object that contains the principal. ```yaml Type: SPClaim Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -75,13 +79,15 @@ Accept wildcard characters: False ``` ### -Values + +> Applicable: SharePoint Server Subscription Edition + Specifies the field values for the credential mapping. ```yaml Type: SecureString[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -91,6 +97,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -102,8 +111,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -113,6 +121,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -120,7 +131,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -130,6 +140,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -137,7 +150,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreGroupCredentialMapping.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreGroupCredentialMapping.md index a0bd46197..dcb35d8f2 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreGroupCredentialMapping.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreGroupCredentialMapping.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoGroupTargetApplication" $firstCredential = ConvertTo-SecureString "LOBDATABASE\fulltimeemployees" -AsPlainText -Force @@ -44,13 +44,15 @@ These users are mapped to a pair of credential values on the External System wit ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the Secure Store application (that contains the principal) from which to delete the credential mapping. ```yaml Type: SPSecureStoreApplication Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -60,13 +62,15 @@ Accept wildcard characters: False ``` ### -Values + +> Applicable: SharePoint Server Subscription Edition + Specifies the field values for the credential mapping. ```yaml Type: SecureString[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +80,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -87,8 +94,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -98,6 +104,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -105,7 +114,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -115,11 +123,13 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreMasterKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreMasterKey.md index a88bc63d2..49586056b 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreMasterKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSecureStoreMasterKey.md @@ -24,19 +24,17 @@ The `Update-SPSecureStoreApplicationServerKey` cmdlet changes the master key of Updating the master key is required when: - --A new instance of a service application is created and the database for the Secure Store service application is new or empty. --The master key or passphrase has been compromised. --Security guidelines require that the passphrase or key be replaced. - For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell $newPassPhrase = "abcDEF123!" $proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'} @@ -48,6 +46,9 @@ This example creates a new master key for the given service application. ## PARAMETERS ### -Passphrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the passphrase that is used for the Secure Store database. The passphrase that you enter is not stored. Make sure that you write down the passphrase and store it in a secure location. @@ -56,8 +57,7 @@ The passphrase will be required to add new Secure Store service servers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -67,13 +67,15 @@ Accept wildcard characters: False ``` ### -ServiceApplicationProxy + +> Applicable: SharePoint Server Subscription Edition + Specifies the proxy of the Secure Store service application that contains the master key to update. ```yaml Type: SPServiceApplicationProxyPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -83,6 +85,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -94,8 +99,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSolution.md index 23f1570f8..3600895be 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Upgrades a deployed SharePoint solution. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Update-SPSolution -Identity contoso_solution.wsp -LiteralPath c:\contoso_solution_v2.wsp -GACDeployment ``` @@ -40,6 +39,9 @@ This example upgrades the deployed SharePoint solution contoso_solution.wsp to ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SharePoint solution to deploy. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. @@ -47,8 +49,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -LiteralPath + +> Applicable: SharePoint Server Subscription Edition + Specifies the path to the solution package. The type must be a valid path in either of the following forms: @@ -68,8 +72,7 @@ The type must be a valid path in either of the following forms: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -90,8 +96,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -CASPolicies + +> Applicable: SharePoint Server Subscription Edition + Specifies that Code Access Security (CAS) policies can be deployed for the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -117,6 +124,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -124,7 +134,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -134,13 +143,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: SharePoint Server Subscription Edition + Forces the deployment of the new SharePoint solution. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -150,13 +161,15 @@ Accept wildcard characters: False ``` ### -GACDeployment + +> Applicable: SharePoint Server Subscription Edition + Specifies that the new SharePoint solution can be deployed to the global assembly cache (GAC). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -166,13 +179,15 @@ Accept wildcard characters: False ``` ### -Local + +> Applicable: SharePoint Server Subscription Edition + Deploys the solution on the local computer only. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -182,6 +197,9 @@ Accept wildcard characters: False ``` ### -Time + +> Applicable: SharePoint Server Subscription Edition + Specifies when the solution will be deployed. The default value is immediate deployment. @@ -190,8 +208,7 @@ The type must be a valid DateTime value, in the form 2010, 5, 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -201,6 +218,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -208,7 +228,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -218,13 +237,15 @@ Accept wildcard characters: False ``` ### -FullTrustBinDeployment + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to deploy using fully trusted bin. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPUserSolution.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPUserSolution.md index 95091c72b..d7c33faa4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPUserSolution.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPUserSolution.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Upgrades an activated sandboxed solution in a farm. - ## SYNTAX ``` @@ -30,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE--------------------- +### EXAMPLE ```powershell Update-SPUserSolution -Identity contoso_solution.wsp -Site https://sitename -ToSolution contoso_solution_v2.wsp ``` @@ -40,6 +39,9 @@ This example upgrades the sandboxed solution contoso_solution.wsp in the site ht ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution to upgrade. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -47,8 +49,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -58,6 +59,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: SharePoint Server Subscription Edition + Upgrade the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form https://server_name; or an instance of a valid SPSite object. @@ -65,8 +69,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -ToSolution + +> Applicable: SharePoint Server Subscription Edition + Specifies the sandboxed solution you want to upgrade to. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. @@ -83,8 +89,7 @@ The type must be a valid name of a sandboxed solution (for example, UserSolution ```yaml Type: SPUserSolutionPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -94,6 +99,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -105,8 +113,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -123,7 +133,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -140,7 +152,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPWOPIProofKey.md b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPWOPIProofKey.md index 25edb127c..5bea4bc28 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPWOPIProofKey.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Update-SPWOPIProofKey.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Updates the public key that is used to connect to the WOPI application on the current SharePoint farm where this cmdlet is run. - ## SYNTAX ``` @@ -29,7 +28,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Update-SPWOPIProofKey -ServerName "Server.corp.Contoso.com" ``` @@ -39,6 +38,9 @@ This example obtains the current public key from the WOPI application (such as a ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -50,8 +52,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -61,6 +62,9 @@ Accept wildcard characters: False ``` ### -ServerName + +> Applicable: SharePoint Server Subscription Edition + Specifies the WOPI application to obtain the key from. This may be a server that runs Office Web Apps Server. If this parameter is missing, public keys for all WOPI applications which are connected to the current SharePoint farm, are updated. @@ -68,8 +72,7 @@ If this parameter is missing, public keys for all WOPI applications which are co ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPAppManagementServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPAppManagementServiceApplication.md index ec8467d0d..5674c768a 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPAppManagementServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPAppManagementServiceApplication.md @@ -2,7 +2,7 @@ external help file: Microsoft.SharePoint.PowerShell.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/upgrade-spappmanagementserviceapplication -Applicable: SharePoint Server Subscription Edition + title: Upgrade-SPAppManagementServiceApplication schema: 2.0.0 --- @@ -32,23 +32,24 @@ Do Not Use ## EXAMPLES -### --------------EXAMPLE----------------- +### EXAMPLE ```powershell Do Not Use ``` - ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -58,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -74,13 +77,15 @@ Accept wildcard characters: False ``` ### -DatabaseIds + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: Guid[] Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: AppManagementSvcAppById -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 0 @@ -106,13 +113,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Do Not Use ```yaml Type: String Parameter Sets: AppManagementSvcAppByName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -129,7 +141,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPContentDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPContentDatabase.md index e09d1772e..0cae05ddc 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPContentDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPContentDatabase.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Resumes a failed database upgrade or begins a build-to-build database upgrade. - ## SYNTAX ### ContentDatabaseById @@ -40,7 +39,7 @@ Use the `Upgrade-SPContentDatabase` cmdlet to resume a failed database upgrade o The `Upgrade-SPContentDatabase` cmdlet initiates an upgrade of an existing content database that is attached to the current farm. This cmdlet begins a new upgrade session, which can be used either to resume a failed version-to-version or build-to-build upgrade of a content database or to begin a build-to-build upgrade of a content database. -If the database is hosted on a version of SQL Server that supports creation and use of snapshots of the database, this cmdlet can use a database snapshot for build-to-build upgrades. +If the database is hosted on a version of SQL Server that supports creation and use of snapshots of the database, this cmdlet can use a database snapshot for build-to-build upgrades. During upgrade, users see a ready-only version of the database, which is the snapshot. After upgrade users see upgraded content. @@ -49,10 +48,9 @@ To prevent build-to-build upgrades of site collections, use the NoB2BSiteUpgrade This cmdlet does not trigger version-to-version upgrade of any site collections. - ## EXAMPLES -### --------------------------EXAMPLE 1------------------------------ +### EXAMPLE 1 ```powershell Upgrade-SPContentDatabase WSS_Content ``` @@ -60,7 +58,7 @@ Upgrade-SPContentDatabase WSS_Content This example upgrades the existing WSS_Content content database schema and then performs only build-to-build upgrade actions on existing site collections if required. This operation does not changed the CompatibilityLevel for existing site collections in this database. -### --------------------------EXAMPLE 2------------------------------ +### EXAMPLE 2 ```powershell Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade ``` @@ -69,18 +67,21 @@ This example upgrades the existing WSS_Content content database schema only. No build-to-build upgrade actions are performed on any site collections. This operation does not change The CompatibilityLevel for existing site collections in this database. -### --------------------------EXAMPLE 3------------------------------ +### EXAMPLE 3 ```powershell Upgrade-SPContentDatabase WSS_Content -NoB2BSiteUpgrade -UseSnapshot ``` -This example upgrades the existing WSS_Content content database schema only while using a snapshot of the database to retain read-only access to the content during the upgrade. +This example upgrades the existing WSS_Content content database schema only while using a snapshot of the database to retain read-only access to the content during the upgrade. No build-to-build upgrade actions are performed on any site collections. This operation does not change the CompatibilityLevel for existing site collections in this database. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the content database to upgrade. The value must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPContentDatabase object. @@ -88,8 +89,7 @@ The value must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefg ```yaml Type: SPContentDatabasePipeBind Parameter Sets: ContentDatabaseById -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -99,13 +99,15 @@ Accept wildcard characters: False ``` ### -ForceDeleteLock + +> Applicable: SharePoint Server Subscription Edition + Forces deletion of locks on the database before the upgrade starts. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: 2 @@ -115,13 +117,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: SharePoint Server Subscription Edition + Specifies the name of attached content database. ```yaml Type: String Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -131,13 +135,15 @@ Accept wildcard characters: False ``` ### -WebApplication + +> Applicable: SharePoint Server Subscription Edition + Specifies the web application that hosts the attached content database. ```yaml Type: SPWebApplicationPipeBind Parameter Sets: ContentDatabaseByName -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -147,6 +153,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -158,8 +167,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -169,6 +177,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -176,7 +187,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -186,13 +196,15 @@ Accept wildcard characters: False ``` ### -NoB2BSiteUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to not upgrade all child objects when performing a build-to-build upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -202,13 +214,15 @@ Accept wildcard characters: False ``` ### -ServerInstance + +> Applicable: SharePoint Server Subscription Edition + The SQL Server instance that hosts the attached content database. ```yaml Type: SPDatabaseServiceInstancePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -218,13 +232,15 @@ Accept wildcard characters: False ``` ### -SkipIntegrityChecks + +> Applicable: SharePoint Server Subscription Edition + Specifies the upgrade process not to run the internal integrity checks such as missing templates and orphan detection as part of the upgrade process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -234,6 +250,9 @@ Accept wildcard characters: False ``` ### -UseSnapshot + +> Applicable: SharePoint Server Subscription Edition + Specifies to use the snapshot method to perform unattached upgrade. This will make a snapshot of the current database and then perform all upgrade operations that apply to the database and optionally to its contents. @@ -245,8 +264,7 @@ This parameter only works for versions of SQL Server that support creation and u ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -256,6 +274,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -263,7 +284,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -273,13 +293,15 @@ Accept wildcard characters: False ``` ### -AllowUnattached + +> Applicable: SharePoint Server Subscription Edition + Lets the upgrade process to proceed on a content database which is not currently attached to a SharePoint farm. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -289,13 +311,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to not upgrade databases and their child objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplication.md index 46b2bb229..349a0cb20 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplication.md @@ -31,21 +31,21 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ----------------EXAMPLE 1----------------- +### EXAMPLE 1 ```powershell Get-SPEnterpriseSearchServiceApplication | Upgrade-SPEnterpriseSearchServiceApplication ``` This example upgrades a search service application. -### ----------------EXAMPLE 2----------------- +### EXAMPLE 2 ```powershell Upgrade-SPEnterpriseSearchServiceApplication -Identity 846ceb0b-31d6-4c79-82c1-3a9deafe0b45 ``` This example upgrades a search service application. -### ----------------EXAMPLE 3----------------- +### EXAMPLE 3 ```powershell Upgrade-SPEnterpriseSearchServiceApplication "DefaultSearchApplication" ``` @@ -55,6 +55,9 @@ This example upgrades a search service application. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the search service application to upgrade. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. @@ -62,8 +65,7 @@ The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh ```yaml Type: SearchServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -73,6 +75,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -84,8 +89,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +109,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -112,6 +118,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -119,7 +128,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md index 171fbd50c..58ad0d8c4 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings.md @@ -27,7 +27,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### --------EXAMPLE-------- +### EXAMPLE ```powershell $site= Get-SPSite https://test Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $site @@ -35,18 +35,19 @@ Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $site This example upgrades the search settings for the site collection referenced by $site. - ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the site collection for which to upgrade search settings. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -56,6 +57,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -67,8 +71,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -95,6 +100,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -102,7 +110,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPFarm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPFarm.md index d855fc6c5..61b0a1211 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPFarm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPFarm.md @@ -12,7 +12,6 @@ schema: 2.0.0 ## SYNOPSIS Activates the Upgrade method for the local farm. - ## SYNTAX ``` @@ -27,7 +26,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ```powershell Upgrade-SPFarm ``` @@ -37,6 +36,9 @@ This example starts the upgrade process on the local farm. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -48,8 +50,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -59,6 +60,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -66,7 +70,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -83,7 +89,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -93,13 +98,15 @@ Accept wildcard characters: False ``` ### -ServerOnly + +> Applicable: SharePoint Server Subscription Edition + Specifies to only upgrade local server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -109,13 +116,15 @@ Accept wildcard characters: False ``` ### -SkipDatabaseUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to not upgrade databases and their child objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,13 +134,15 @@ Accept wildcard characters: False ``` ### -SkipSiteUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to not upgrade all site objects when performing upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: NoB2BSiteUpgrade -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPProfileServiceApplication.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPProfileServiceApplication.md index f77ae1d70..ace3e87c9 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPProfileServiceApplication.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPProfileServiceApplication.md @@ -2,7 +2,7 @@ external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml module name: SharePointServer online version: https://learn.microsoft.com/powershell/module/sharepoint-server/upgrade-spprofileserviceapplication -Applicable: SharePoint Server Subscription Edition + title: Upgrade-SPProfileServiceApplication schema: 2.0.0 --- @@ -24,7 +24,7 @@ Upgrades User Profile Service and its related profile and social store. ## EXAMPLES -### -----------EXAMPLE--------- +### EXAMPLE ```powershell $sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'} Upgrade-SPProfileServiceApplication $sa @@ -35,6 +35,9 @@ This example upgrades the specified user profile service application. ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur. @@ -42,8 +45,7 @@ When the Global parameter is used, all objects are contained in the global store ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -53,13 +55,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -69,13 +73,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the User Profile Service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a user profile service application (for example, UserProfileServiceApp); or an instance of a valid SPServiceApplication object. ```yaml Type: SPServiceApplicationPipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 0 @@ -85,6 +91,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -92,7 +101,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSingleSignOnDatabase.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSingleSignOnDatabase.md index 2b64b0da9..188a2a9c3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSingleSignOnDatabase.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSingleSignOnDatabase.md @@ -29,7 +29,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### ------------------EXAMPLE------------------ +### EXAMPLE ```powershell Upgrade-SPSingleSignOnDatabase -SSOConnectionString "Data Source=oldServer;Database=SSO;Trusted_Connection=yes;" -SecureStoreConnectionString "Data Source=CONTOSO\SQLDatabase;Database=ContosoSSDatabase;Trusted_Connection=yes;" -SecureStorePassphrase "abcDEF123!@#" ``` @@ -39,13 +39,15 @@ This example migrates the SSO database at the SSO connection to a Secure Store d ## PARAMETERS ### -SecureStoreConnectionString + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server connection string for the Secure Store database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -SecureStorePassphrase + +> Applicable: SharePoint Server Subscription Edition + Specifies the passphrase used for the Secure Store database. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -71,13 +75,15 @@ Accept wildcard characters: False ``` ### -SSOConnectionString + +> Applicable: SharePoint Server Subscription Edition + Specifies the SQL Server connection string for the SSO database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: Named @@ -87,6 +93,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -98,8 +107,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSite.md b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSite.md index c43831580..581609df3 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSite.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Upgrade-SPSite.md @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE 1---------- +### EXAMPLE 1 ```powershell Upgrade-SPSite https:///sites/testsite ``` @@ -43,7 +43,7 @@ Upgrade-SPSite https:///sites/testsite This example upgrades the existing https://\/sites/testsite site collection by using only build-to-build upgrade actions. The SPSite.CompatibilityLevel will not be changed by this operation. -### -------------EXAMPLE 2---------- +### EXAMPLE 2 ```powershell Upgrade-SPSite https:///sites/testsite -VersionUpgrade ``` @@ -54,13 +54,15 @@ The SPSite.CompatibilityLevel will not be changed by this operation. ## PARAMETERS ### -Identity + +> Applicable: SharePoint Server Subscription Edition + Specifies the SPSite object to run upgrade operations against. ```yaml Type: SPSitePipeBind Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: True Position: 1 @@ -70,6 +72,9 @@ Accept wildcard characters: False ``` ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -81,8 +86,7 @@ If objects are not immediately used, or disposed of by using the `Stop-SPAssignm ```yaml Type: SPAssignmentCollection Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -92,6 +96,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -99,7 +106,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -109,13 +115,15 @@ Accept wildcard characters: False ``` ### -Email + +> Applicable: SharePoint Server Subscription Edition + Specifies whether to send mail on completion of the site collection upgrade. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -125,13 +133,15 @@ Accept wildcard characters: False ``` ### -QueueOnly -Specifies to put the site into the queue for a delayed upgrade that is managed by a timer job. + +> Applicable: SharePoint Server Subscription Edition + +Specifies to put the site into the queue for a delayed upgrade that is managed by a timer job. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -141,13 +151,15 @@ Accept wildcard characters: False ``` ### -Unthrottled + +> Applicable: SharePoint Server Subscription Edition + Specifies a farm administrator to bypass the throttle which permits a site collection to be upgraded even if there are "too many" site collections in the throttle to be upgraded. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -157,6 +169,9 @@ Accept wildcard characters: False ``` ### -VersionUpgrade + +> Applicable: SharePoint Server Subscription Edition + Specifies to perform a version-to-version upgrade on the SPSite object. When this parameter is set, it internally triggers all available build-to-build actions that are associated with the current site collection operating mode. Version-to-version actions follow to bring site collections to the next site collection operating mode inclusive of all new build-to-build actions that are associated with the new site collection operating mode. @@ -165,8 +180,7 @@ When this parameter is not set, it triggers only available build-to-build upgrad ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named @@ -176,6 +190,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -183,7 +200,6 @@ For more information, type the following command: `get-help about_commonparamete Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -193,6 +209,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: SharePoint Server Subscription Edition + Specifies what priority to upgrade the site. The valid values are: @@ -206,8 +225,7 @@ The valid values are: ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server Subscription Edition +Aliases: Required: False Position: Named diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Use-SPCacheCluster.md b/sharepoint/sharepoint-server-ps/SharePointServer/Use-SPCacheCluster.md index 6f3a23c53..92bbd9a1e 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Use-SPCacheCluster.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Use-SPCacheCluster.md @@ -25,7 +25,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -------------EXAMPLE------------- +### EXAMPLE ```powershell Use-SPCacheCluster ``` @@ -35,6 +35,9 @@ This example sets the context of your PowerShell session to current farm's cache ## PARAMETERS ### -AssignmentCollection + +> Applicable: SharePoint Server Subscription Edition + Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. @@ -47,7 +50,6 @@ If objects are not immediately used, or disposed of by using the Stop-SPAssignme Type: SPAssignmentCollection Parameter Sets: (All) Aliases: -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Server Subscription Edition + Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Server Subscription Edition Required: False Position: Named @@ -73,6 +77,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Server Subscription Edition + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: \`get-help about_commonparameters\` @@ -80,7 +87,6 @@ For more information, type the following command: \`get-help about_commonparamet Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Server Subscription Edition Required: False Position: Named From 84de6299198a66307cbd6a0062165187a477239c Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 16 Jul 2025 15:41:22 -0500 Subject: [PATCH 2/2] Fix broken Example header --- .../Microsoft.SharePoint.Powershell/Get-SPFarm.md | 3 +-- .../sharepoint-server-ps/SharePointServer/Get-SPFarm.md | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md index b650eb52f..96a99c28e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md +++ b/sharepoint/sharepoint-ps/Microsoft.SharePoint.Powershell/Get-SPFarm.md @@ -16,7 +16,6 @@ ms.reviewer: Returns the local SharePoint farm. - ## SYNTAX ``` @@ -31,7 +30,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### +### EXAMPLE 1 ``` C:\PS>$f = Get-SPFarm ``` diff --git a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md index dc4ca302a..3274b09de 100644 --- a/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md +++ b/sharepoint/sharepoint-server-ps/SharePointServer/Get-SPFarm.md @@ -13,7 +13,6 @@ schema: 2.0.0 Returns the local SharePoint farm. - ## SYNTAX ``` @@ -28,7 +27,8 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### +### EXAMPLE 1 + ```powershell $f = Get-SPFarm ```